• Buy Now
    • Rackspace Cloud
    • Email & Apps
    • Fanatical Support for AWS
    • Managed Google Cloud Platform
    • Office 365
  • Log In
    • MyRackspace Portal
    • Cloud Control Panel
    • Rackspace Webmail Login
    • Cloud Office Control Panel
  • Rackspace Logo
  • Developer Home
  • Developer Documentation
  • Blogs ▼
    • Technical Blog
    • Rackspace Blog
    • Solve: Thought Leadership
  • Support Documentation

Developer Docs


Let’s Build Something Powerful Together!

End-to-End Multicloud Solutions.   Solving Together.™   Learn more at Rackspace.com

Submit an issue
  • Cloud Load Balancers 1.0
  • Getting started
    • Get your credentials
    • Sending API requests to Cloud Load Balancers
      • Convert cURL examples to run on Windows
    • Authenticate to the Rackspace Cloud
      • Send an authentication request
      • Review the authentication response
      • Configure environment variables
    • Load balancer concepts
      • Load balancer
      • Virtual IP
      • Error page
      • Node
      • Health monitor
      • Session persistence
      • Connection logging
    • Create and manage Cloud Load Balancers
      • Creating Cloud Servers
      • Creating a Load Balancer
      • Listing Load Balancer details
      • Adding a node
      • Updating Load Balancer attributes
  • General API information
    • Service access endpoints
    • Request and response types
    • Content compression
    • Persistent connections
    • Paginated collections
    • Limits
      • Rate limits
      • Absolute limits
      • Retrieve account limits
    • Faults
      • serviceFault
      • badRequest
      • immutableEntity
      • itemNotFound
      • loadBalancerFault
      • outOfVirtualIps
      • overLimit
      • serviceUnavailable
      • unauthorized
      • unprocessableEntity
    • Date and time format
    • API behavior and statuses
    • Compatible shared load balancing protocols
      • DNS-compatible load balancing protocols
      • TCP- and UDP-compatible load balancing protocols
    • Role-based access control (RBAC)
      • Assigning roles to account users
      • Roles available for Rackspace Cloud Load Balancers
      • Multiproduct global roles and permissions
      • Resolving conflicts between RBAC multiproduct and product-specific roles
      • RBAC permissions cross-reference to Rackspace Cloud Load Balancers API operations
    • HTTP/2 Support
  • API reference
    • Load balancers
      • List load balancers
      • Create load balancer
      • Bulk-delete load balancers
      • Show load balancer details
      • Update load balancer properties
      • Delete load balancer
    • Error pages
      • Show custom error page
      • Set custom error page
      • Delete custom error page
    • Load balancer statistics
      • Show load balancer statistics
    • Nodes
      • List nodes
      • Add node
      • Bulk-delete nodes
      • Show node details
      • Update node
      • Delete node
      • List node service events
    • Virtual IPs
      • List virtual IPs
      • Add virtual IP version 6
      • Bulk-delete virtual IPs
      • Delete virtual IP
    • Allowed domains
      • List allowed domains
    • Usage reports
      • Show historical usage
      • Show account-level usage
      • Show current usage
      • List billable load balancers
    • Access lists
      • Show access list
      • Create or update access list
      • Delete access list
      • Bulk-delete networks from access list
      • Delete network from access list
    • Monitors
      • Show health monitor configuration
      • Update health monitor
      • Delete health monitor
    • Session persistence
      • Show session persistence configuration
      • Enable session persistence
      • Disable session persistence
    • Log connections
      • Show connection logging configuration
      • Enable or disable connection logging
    • Throttle connections
      • Show connection throttling configuration
      • Create or update connection throttling configuration
      • Delete connection throttling configuration
    • Content caching
      • Show content caching configuration
      • Enable content caching
    • Protocols
      • List load balancing protocols
    • Algorithms
      • List load balancing algorithms
    • SSL termination
      • Show SSL termination configuration
      • Update SSL termination configuration
      • Delete SSL termination
    • Certificate mappings
      • List certificate mappings
      • Add certificate mapping
      • Show certificate mappings details
      • Update certificate mapping
      • Delete certificate mapping
    • Ciphers
      • Cipher profiles
      • Cipher Statuses
      • List ciphers
    • Metadata
      • Add load balancer metadata
      • Show load balancer metadata
      • Bulk-delete load balancer metadata items
      • Show load balancer metadata item
      • Update load balancer metadata item
      • Delete load balancer metadata item
      • Show load balancer node metadata
      • Add load balancer node metadata item
      • Bulk-delete load balancer node metadata items
      • Show load balancer node metadata item
      • Update load balancer node metadata item
      • Delete load balancer node metadata item
  • Release notes
    • v1.27.09, Nov 18th, 2020
      • What's new
      • Resolved issues
      • Known issues
    • v1.27.07, Oct 21st, 2020
      • What's new
      • Resolved issues
      • Known issues
    • v1.27.06, Sept 29th, 2020
      • What's new
      • Resolved issues
      • Known issues
    • v1.27.05, Sept 9th, 2020
      • What's new
      • Resolved issues
      • Known issues
    • v1.27.04, Aug 26th, 2020
      • What's new
      • Resolved issues
      • Known issues
    • v1.27.03, Aug 12th, 2020
      • What's new
      • Resolved issues
      • Known issues
    • v1.27.01, Jul 6th, 2020
      • What's new
      • Resolved issues
      • Known issues
    • v1.26.30, Jan 29th, 2020
      • What's new
      • Resolved issues
      • Known issues
    • v1.26.29, Jan 13th, 2020
      • What's new
      • Resolved issues
      • Known issues
    • v1.26.27, Oct 22nd, 2019
      • What's new
      • Resolved issues
      • Known issues
    • v1.26.23, Sep 18th, 2019
      • What's new
      • Resolved issues
      • Known issues
    • v1.26.17, Jul 10th, 2019
      • What's new
      • Resolved issues
      • Known issues
    • v1.26.15, Jun 4th, 2019
      • What's new
      • Resolved issues
      • Known issues
    • v1.26.13, May 22nd, 2019
      • What's new
      • Resolved issues
      • Known issues
    • v1.26.10, April 1st 2019
      • What's new
      • Resolved issues
      • Known issues
    • v1.25.56, March 13th 2018
      • What's new
      • Resolved issues
      • Known issues
    • API 1.0 updates, August 23, 2016
      • What's new
      • Resolved issues
      • Known issues
    • API 1.0 updates, June 29, 2016
      • What's new
      • Resolved issues
      • Known issues
    • v1.25.26, February 5, 2016
      • What's new
      • Resolved issues
      • Known issues
    • v1.23.7, October 7, 2014
      • What's new
      • Resolved issues
      • Known issues
    • v1.22.10, August 1, 2014
      • What's new
      • Resolved issues
      • Known issues
    • v1.21.14, June 17, 2014
      • What's new
      • Resolved issues
      • Known issues
    • v1.21.12, June 6, 2014
      • What's new
      • Resolved issues
      • Known issues
    • v1.20.22, March 24, 2014
      • What's new
      • Resolved issues
      • Known issues
    • v1.19.32, February 26, 2014
      • What's new
      • Resolved issues
      • Known issues
  • Additional resources
  • Disclaimer

Metadata¶

  • Add load balancer metadata
  • Show load balancer metadata
  • Bulk-delete load balancer metadata items
  • Show load balancer metadata item
  • Update load balancer metadata item
  • Delete load balancer metadata item
  • Show load balancer node metadata
  • Add load balancer node metadata item
  • Bulk-delete load balancer node metadata items
  • Show load balancer node metadata item
  • Update load balancer node metadata item
  • Delete load balancer node metadata item

Metadata can be associated with each load balancer and each node for the client's personal use. It is defined using key-value pairs where the key and value consist of alphanumeric characters. A key is unique per load balancer.

Add load balancer metadata¶

POST /v1.0/{account}/loadbalancers/{loadBalancerId}/metadata

Adds a metadata item to the load balancer.

When a metadata item is added, it is assigned a unique identifier that can be used for mutating operations such as changing the value attribute or removing it.

The following table shows the possible response codes for this operation:

Response Code Name Description
200 Success Request succeeded.
400 Bad Request The request is missing one or more elements, or the values of some elements are invalid.
401 Unauthorized You are not authorized to complete this operation. This error can occur if the request is submitted with an invalid authentication token.
404 Not Found The requested item was not found.
413 Over Limit The number of items returned is above the allowed limit.
422 ImmutableEntity This fault is returned when a user attempts to modify an item that is not currently in a state that allows modification. For example, load balancers in a status of PENDING_UPDATE,BUILD, or DELETED may not be modified.
500 Load Balancer Fault The load balancer has experienced a fault.
503 Service Unavailable The service is not available.

Request¶

The following table shows the URI parameters for the request:

Name Type Description
{account} String The ID for the tenant or account in a multi- tenancy cloud.
{loadBalancerId} String The ID for the load balancer.

The following table shows the body parameters for the request:

Name Type Description
key String (Required) Key that is used to identify the metadata. Must be 256 characters or fewer. All UTF-8 characters are valid.
value String (Required) Value for the metadata item. Must be 256 characters or less. All UTF-8 characters are valid.

Example Add load balancer metadata: JSON request

{
  "meta": {
    "key":"color",
    "value":"blue"
  }
}

Example Add load balancer metadata: XML request

<metadata xmlns="http://docs.openstack.org/loadbalancers/api/v1.0">
    <meta key="xml color">blue</meta>
</metadata>

Response¶

Example Add load balancer metadata: JSON response

{
    "metadata": [
        {
            "value": "blue",
            "key": "color",
            "id": 1
        }
    ]
}

Example Add load balancer metadata: XML response

<metadata xmlns="http://docs.openstack.org/loadbalancers/api/v1.0">
    <meta id="1" key="xml color">blue</meta>
</metadata>

Show load balancer metadata¶

GET /v1.0/{account}/loadbalancers/{loadBalancerId}/metadata

Shows all metadata associated with the specified load balancer.

The following table shows the possible response codes for this operation:

Response Code Name Description
200 Success Request succeeded.
400 Bad Request The request is missing one or more elements, or the values of some elements are invalid.
401 Unauthorized You are not authorized to complete this operation. This error can occur if the request is submitted with an invalid authentication token.
404 Not Found The requested item was not found.
413 Over Limit The number of items returned is above the allowed limit.
422 ImmutableEntity This fault is returned when a user attempts to modify an item that is not currently in a state that allows modification. For example, load balancers in a status of PENDING_UPDATE,BUILD, or DELETED may not be modified.
500 Load Balancer Fault The load balancer has experienced a fault.
503 Service Unavailable The service is not available.

Request¶

The following table shows the URI parameters for the request:

Name Type Description
{account} String The ID for the tenant or account in a multi- tenancy cloud.
{loadBalancerId} String The ID for the load balancer.

This operation does not accept a request body.

Response¶

Example Show load balancer metadata: JSON response

{
  "metadata": [
    {
      "id":"1",
      "key":"color",
      "value":"red"
    },
    {
      "id":"2",
      "key":"label",
      "value":"web-load-balancer"
    }
  ]
}

Example Show load balancer metadata: XML response

<metadata xmlns="http://docs.openstack.org/loadbalancers/api/v1.0">
  <meta id="1" key="color">red</meta>
  <meta id="2" key="label">web-load-balancer</meta>
</metadata>

Bulk-delete load balancer metadata items¶

DELETE /v1.0/{account}/loadbalancers/{loadBalancerId}/metadata

Bulk-deletes the metadata items given specified id list.

To bulk-delete metadata, provide a query parameter list of meta IDs. For example: /metadata?id= metaId & id= metaId. The current default limit is ten IDs per request. Any and all configuration data is immediately purged and is not recoverable. If one of the items in the list cannot be removed due to its current status, a 400:BadRequest is returned along with the IDs of the ones the system identified as potential failures for this request.

The following table shows the possible response codes for this operation:

Response Code Name Description
200 Success Request succeeded.
400 Bad Request The request is missing one or more elements, or the values of some elements are invalid.
401 Unauthorized You are not authorized to complete this operation. This error can occur if the request is submitted with an invalid authentication token.
404 Not Found The requested item was not found.
413 Over Limit The number of items returned is above the allowed limit.
422 ImmutableEntity This fault is returned when a user attempts to modify an item that is not currently in a state that allows modification. For example, load balancers in a status of PENDING_UPDATE,BUILD, or DELETED may not be modified.
500 Load Balancer Fault The load balancer has experienced a fault.
503 Service Unavailable The service is not available.

Request¶

The following table shows the URI parameters for the request:

Name Type Description
{account} String The ID for the tenant or account in a multi- tenancy cloud.
{loadBalancerId} String The ID for the load balancer.

The following table shows the query parameters for the request:

Name Type Description
metaId String The ID for the metadata item.

This operation does not accept a request body.

Response¶

This operation does not return a response body.

Show load balancer metadata item¶

GET /v1.0/{account}/loadbalancers/{loadBalancerId}/metadata/{metaId}

Shows details for a specified metadata item for a specified load balancer. The following table shows the possible response codes for this operation:

Response Code Name Description
200 Success Request succeeded.
400 Bad Request The request is missing one or more elements, or the values of some elements are invalid.
401 Unauthorized You are not authorized to complete this operation. This error can occur if the request is submitted with an invalid authentication token.
404 Not Found The requested item was not found.
413 Over Limit The number of items returned is above the allowed limit.
422 ImmutableEntity This fault is returned when a user attempts to modify an item that is not currently in a state that allows modification. For example, load balancers in a status of PENDING_UPDATE,BUILD, or DELETED may not be modified.
500 Load Balancer Fault The load balancer has experienced a fault.
503 Service Unavailable The service is not available.

Request¶

The following table shows the URI parameters for the request:

Name Type Description
{account} String The ID for the tenant or account in a multi- tenancy cloud.
{loadBalancerId} String The ID for the load balancer.
{metaId} String The ID of the metadata item.

This operation does not accept a request body.

Response¶

Example Show load balancer metadata item: JSON response

{"meta": {
        "id":4,
        "key":"color",
        "value":"red"
    }
}

Example Show load balancer metadata item: XML response

<meta xmlns="http://docs.openstack.org/loadbalancers/api/v1.0" id="1" key="color">red</meta>

Update load balancer metadata item¶

PUT /v1.0/{account}/loadbalancers/{loadBalancerId}/metadata/{metaId}

Updates the configuration of a metadata item on the load balancer.

Note

The meta data item's id and key are immutable attributes and cannot be modified with a PUT request. Supplying an unsupported attribute results in a 400 (badRequest) fault. A load balancer and a node supports a maximum of 25 metadata items.

The following table shows the possible response codes for this operation:

Response Code Name Description
200 Success Request succeeded.
400 Bad Request The request is missing one or more elements, or the values of some elements are invalid.
401 Unauthorized You are not authorized to complete this operation. This error can occur if the request is submitted with an invalid authentication token.
404 Not Found The requested item was not found.
413 Over Limit The number of items returned is above the allowed limit.
422 ImmutableEntity This fault is returned when a user attempts to modify an item that is not currently in a state that allows modification. For example, load balancers in a status of PENDING_UPDATE,BUILD, or DELETED may not be modified.
500 Load Balancer Fault The load balancer has experienced a fault.
503 Service Unavailable The service is not available.

Request¶

The following table shows the URI parameters for the request:

Name Type Description
{account} String The ID for the tenant or account in a multi- tenancy cloud.
{loadBalancerId} String The ID for the load balancer.
{metaId} String The ID of the metadata item.

The following table shows the body parameters for the request:

Name Type Description
value String (Required) Value for the metadata item. Must be 256 characters or less. All UTF-8 characters are valid.

Example Update load balancer metadata item: JSON request

{
  "meta": {
    "value":"blue"
  }
}

Example Update load balancer metadata item: XML request

<meta xmlns="http://docs.openstack.org/loadbalancers/api/v1.0">blue</meta>

Response¶

This operation does not return a response body.

Delete load balancer metadata item¶

DELETE /v1.0/{account}/loadbalancers/{loadBalancerId}/metadata/{metaId}

Deletes a metadata item from the load balancer.

Any and all configuration data is immediately purged and is not recoverable. The following table shows the possible response codes for this operation:

Response Code Name Description
200 Success Request succeeded.
400 Bad Request The request is missing one or more elements, or the values of some elements are invalid.
401 Unauthorized You are not authorized to complete this operation. This error can occur if the request is submitted with an invalid authentication token.
404 Not Found The requested item was not found.
413 Over Limit The number of items returned is above the allowed limit.
422 ImmutableEntity This fault is returned when a user attempts to modify an item that is not currently in a state that allows modification. For example, load balancers in a status of PENDING_UPDATE,BUILD, or DELETED may not be modified.
500 Load Balancer Fault The load balancer has experienced a fault.
503 Service Unavailable The service is not available.

Request¶

The following table shows the URI parameters for the request:

Name Type Description
{account} String The ID for the tenant or account in a multi- tenancy cloud.
{loadBalancerId} String The ID for the load balancer.
{metaId} String The ID of the metadata item.

This operation does not accept a request body.

Response¶

This operation does not return a response body.

Show load balancer node metadata¶

GET /v1.0/{account}/loadbalancers/{loadBalancerId}/nodes/{nodeId}/metadata

Shows all metadata associated with a specified node.

The following table shows the possible response codes for this operation:

Response Code Name Description
200 Success Request succeeded.
400 Bad Request The request is missing one or more elements, or the values of some elements are invalid.
401 Unauthorized You are not authorized to complete this operation. This error can occur if the request is submitted with an invalid authentication token.
404 Not Found The requested item was not found.
413 Over Limit The number of items returned is above the allowed limit.
422 ImmutableEntity This fault is returned when a user attempts to modify an item that is not currently in a state that allows modification. For example, load balancers in a status of PENDING_UPDATE,BUILD, or DELETED may not be modified.
500 Load Balancer Fault The load balancer has experienced a fault.
503 Service Unavailable The service is not available.

Request¶

The following table shows the URI parameters for the request:

Name Type Description
{account} String The ID for the tenant or account in a multi- tenancy cloud.
{loadBalancerId} String The ID for the load balancer.
{nodeId} String The ID for the node.

This operation does not accept a request body.

Response¶

Example Show load balancer node metadata: JSON response

{
  "metadata": [
    {
      "id":"1",
      "key":"color",
      "value":"red"
    },
    {
      "id":"2",
      "key":"label",
      "value":"web-load-balancer"
    }
  ]
}

Example Show load balancer node metadata: XML response

<metadata xmlns="http://docs.openstack.org/loadbalancers/api/v1.0">
  <meta id="1" key="color">red</meta>
  <meta id="2" key="label">web-load-balancer</meta>
</metadata>

Add load balancer node metadata item¶

POST /v1.0/{account}/loadbalancers/{loadBalancerId}/nodes/{nodeId}/metadata

Adds a metadata item to a specified node.

When a metadata item is added, it is assigned a unique identifier that can be used for mutating operations such as changing the value attribute or removing it.

The following table shows the possible response codes for this operation:

Response Code Name Description
200 Success Request succeeded.
400 Bad Request The request is missing one or more elements, or the values of some elements are invalid.
401 Unauthorized You are not authorized to complete this operation. This error can occur if the request is submitted with an invalid authentication token.
404 Not Found The requested item was not found.
413 Over Limit The number of items returned is above the allowed limit.
422 ImmutableEntity This fault is returned when a user attempts to modify an item that is not currently in a state that allows modification. For example, load balancers in a status of PENDING_UPDATE,BUILD, or DELETED may not be modified.
500 Load Balancer Fault The load balancer has experienced a fault.
503 Service Unavailable The service is not available.

Request¶

The following table shows the URI parameters for the request:

Name Type Description
{account} String The ID for the tenant or account in a multi- tenancy cloud.
{loadBalancerId} String The ID for the load balancer.
{nodeId} String The ID for the node.

The following table shows the body parameters for the request:

Name Type Description
key String (Required) Key that is used to identify the metadata. Must be 256 characters or fewer. All UTF-8 characters are valid.
value String (Required) Value for the metadata item. Must be 256 characters or less. All UTF-8 characters are valid.

Example Add load balancer node metadata item: JSON request

{
  "meta": {
    "key":"color",
    "value":"blue"
  }
}

Example Add load balancer node metadata item: XML request

<metadata xmlns="http://docs.openstack.org/loadbalancers/api/v1.0">
    <meta key="xml color">blue</meta>
</metadata>

Response¶

Example Add load balancer metadata: JSON response

{
    "metadata": [
        {
            "value": "blue",
            "key": "color",
            "id": 1
        }
    ]
}

Example Add load balancer metadata: XML response

<metadata xmlns="http://docs.openstack.org/loadbalancers/api/v1.0">
    <meta id="1" key="xml color">blue</meta>
</metadata>

Bulk-delete load balancer node metadata items¶

DELETE /v1.0/{account}/loadbalancers/{loadBalancerId}/nodes/{nodeId}/metadata

Bulk-deletes the metadata items given specified id list.

To bulk-delete metadata, provide a query parameter list of meta IDs. For example: /metadata?id='metaId' & id='metaId'. The current default limit is ten IDs per request. Any and all configuration data is immediately purged and is not recoverable. If one of the items in the list cannot be removed due to its current status, a 400:BadRequest is returned along with the IDs of the ones the system identified as potential failures for this request.

The following table shows the possible response codes for this operation:

Response Code Name Description
200 Success Request succeeded.
400 Bad Request The request is missing one or more elements, or the values of some elements are invalid.
401 Unauthorized You are not authorized to complete this operation. This error can occur if the request is submitted with an invalid authentication token.
404 Not Found The requested item was not found.
413 Over Limit The number of items returned is above the allowed limit.
422 ImmutableEntity This fault is returned when a user attempts to modify an item that is not currently in a state that allows modification. For example, load balancers in a status of PENDING_UPDATE,BUILD, or DELETED may not be modified.
500 Load Balancer Fault The load balancer has experienced a fault.
503 Service Unavailable The service is not available.

Request¶

The following table shows the URI parameters for the request:

Name Type Description
{account} String The ID for the tenant or account in a multi- tenancy cloud.
{loadBalancerId} String The ID for the load balancer.
{nodeId} String The ID for the node.

The following table shows the query parameters for the request:

Name Type Description
metaId String The ID for the metadata item.

This operation does not accept a request body.

Response¶

This operation does not return a response body.

Show load balancer node metadata item¶

GET /v1.0/{account}/loadbalancers/{loadBalancerId}/nodes/{nodeId}/metadata/{metaId}

Shows details for a specified metadata item for a specified node of the load balancer.

The following table shows the possible response codes for this operation:

Response Code Name Description
200 Success Request succeeded.
400 Bad Request The request is missing one or more elements, or the values of some elements are invalid.
401 Unauthorized You are not authorized to complete this operation. This error can occur if the request is submitted with an invalid authentication token.
404 Not Found The requested item was not found.
413 Over Limit The number of items returned is above the allowed limit.
422 ImmutableEntity This fault is returned when a user attempts to modify an item that is not currently in a state that allows modification. For example, load balancers in a status of PENDING_UPDATE,BUILD, or DELETED may not be modified.
500 Load Balancer Fault The load balancer has experienced a fault.
503 Service Unavailable The service is not available.

Request¶

The following table shows the URI parameters for the request:

Name Type Description
{account} String The ID for the tenant or account in a multi- tenancy cloud.
{loadBalancerId} String The ID for the load balancer.
{nodeId} String The ID for the node.
{metaId} String The ID of the metadata item.

This operation does not accept a request body.

Response¶

Example Show load balancer node metadata item: JSON response

{"meta": {
        "id":4,
        "key":"color",
        "value":"red"
    }
}

Example Show load balancer node metadata item: XML response

<meta xmlns="http://docs.openstack.org/loadbalancers/api/v1.0" id="1" key="color">red</meta>

Update load balancer node metadata item¶

PUT /v1.0/{account}/loadbalancers/{loadBalancerId}/nodes/{nodeId}/metadata/{metaId}

Updates the configuration of a metadata item on the node.

Note

The meta data item's id and key are immutable attributes and cannot be modified with a PUT request. Supplying an unsupported attribute results in a 400 (badRequest) fault. A load balancer and node support a maximum of 25 metadata items.

The following table shows the possible response codes for this operation:

Response Code Name Description
200 Success Request succeeded.
400 Bad Request The request is missing one or more elements, or the values of some elements are invalid.
401 Unauthorized You are not authorized to complete this operation. This error can occur if the request is submitted with an invalid authentication token.
404 Not Found The requested item was not found.
413 Over Limit The number of items returned is above the allowed limit.
422 ImmutableEntity This fault is returned when a user attempts to modify an item that is not currently in a state that allows modification. For example, load balancers in a status of PENDING_UPDATE,BUILD, or DELETED may not be modified.
500 Load Balancer Fault The load balancer has experienced a fault.
503 Service Unavailable The service is not available.

Request¶

The following table shows the URI parameters for the request:

Name Type Description
{account} String The ID for the tenant or account in a multi- tenancy cloud.
{loadBalancerId} String The ID for the load balancer.
{nodeId} String The ID for the node.
{metaId} String The ID of the metadata item.

The following table shows the body parameters for the request:

Name Type Description
value String (Required) Value for the metadata item. Must be 256 characters or less. All UTF-8 characters are valid.

Example Update load balancer node metadata item: JSON request

{
  "meta": {
    "value":"blue"
  }
}

Example Update load balancer node metadata item: XML request

<meta xmlns="http://docs.openstack.org/loadbalancers/api/v1.0">blue</meta>

Response¶

Example Update load balancer node metadata item: JSON response

{
    "meta": {
        "value": "blue",
        "key": "color",
        "id": 1
    }
}

Example Update load balancer node metadata item: XML response

<meta xmlns="http://docs.openstack.org/loadbalancers/api/v1.0" id="1" key="xml color">blue</meta>

Delete load balancer node metadata item¶

DELETE /v1.0/{account}/loadbalancers/{loadBalancerId}/nodes/{nodeId}/metadata/{metaId}

Deletes a metadata item from the node.

Any and all configuration data is immediately purged and is not recoverable. The following table shows the possible response codes for this operation:

Response Code Name Description
200 Success Request succeeded.
400 Bad Request The request is missing one or more elements, or the values of some elements are invalid.
401 Unauthorized You are not authorized to complete this operation. This error can occur if the request is submitted with an invalid authentication token.
404 Not Found The requested item was not found.
413 Over Limit The number of items returned is above the allowed limit.
422 ImmutableEntity This fault is returned when a user attempts to modify an item that is not currently in a state that allows modification. For example, load balancers in a status of PENDING_UPDATE,BUILD, or DELETED may not be modified.
500 Load Balancer Fault The load balancer has experienced a fault.
503 Service Unavailable The service is not available.

Request¶

The following table shows the URI parameters for the request:

Name Type Description
{account} String The ID for the tenant or account in a multi- tenancy cloud.
{loadBalancerId} String The ID for the load balancer.
{nodeId} String The ID for the node.
{metaId} String The ID of the metadata item.

This operation does not accept a request body.

Response¶

This operation does not return a response body.

Previous Ciphers
Next Release notes
Developer Network
  • Developer Center
  • API Documentation and User Guides
  • SDKs
  • Rackspace How-To
Blogs
  • Technical Blog
  • Rackspace Blog
  • Solve: Thought Leadership
Other Information
  • Customer Stories
  • Events
  • Programs
  • Careers
  • Style Guide for Technical Content
©2020 Rackspace US, Inc.
  • ©2020 Rackspace US, Inc.
  • About Rackspace
  • Privacy Statement
  • Website Terms
  • Trademarks