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:

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

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

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:

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

<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:

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:

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

<meta 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.

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

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

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

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:

Show load balancer node metadata¶

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

Shows all metadata associated with a specified node and load balancer.

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

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

<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 and 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:

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

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

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:

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 and load balancer.

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

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

<meta 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.

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

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

<meta xmlns="http://docs.openstack.org/loadbalancers/api/v1.0">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: