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.