• Elastic Load Balancing

elb
  1. Help Center
  2. Elastic Load Balancing
  3. API Reference
  4. Enhanced Load Balancer APIs
  5. Tag
  6. Adding or Deleting Load Balancer Tags in Batches

Adding or Deleting Load Balancer Tags in Batches

Function

This API is used to add or delete load balancer tags in batches.

Constraints

A maximum of 10 tags can be added to a load balancer.

This API is idempotent.

  • Pay attention to the following when adding tags:
    • If there are duplicate keys in the request body, an error is reported.
    • If there are no duplicate keys in the request body but the key in the request body exists in the database, the key in the database is overwritten.
  • Pay attention to the following during the deletion:
    • If the tag to be deleted does not exist, the deletion is considered successful by default.
    • The value range of the tag character set is not verified.
    • The tag structure body cannot be missing, and the key cannot be left blank or set to an empty string.

URI

POST /v2.0/{project_id}/loadbalancers/{loadbalancer_id}/tags/action

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the ID of the project where the tag is used.

loadbalancer_id

Yes

Uuid

Specifies the ID of the load balancer to which tags are to be added or from which tags are to be deleted.

Request

  • Request parameters
    Table 2 Parameter description

    Parameter

    Mandatory

    Type

    Description

    tags

    Yes

    List

    Lists the tags. For details, see Table 3.

    action

    Yes

    String

    Specifies the operation type.

    The value can be one of the following:

    • create: adds tags to the load balancer.
    • delete: deletes tags from the load balancer.
    Table 3 tags field description

    Parameter

    Mandatory

    Type

    Description

    key

    Yes

    String

    Specifies the tag key. It contains a maximum of 36 Unicode characters, and cannot be left blank or contain asterisks (*), angle brackets (< and >), backslashes (\), equal signs (=), commas (,), vertical bars (|), or slashes (/).

    value

    Yes

    String

    Lists the tag values.

    This parameter is mandatory when action is set to create. If value is specified, tags are deleted by key and value. If value is not specified, tags are deleted by key.

    Each tag value contains a maximum of 43 Unicode characters and can also be an empty string. The value cannot be left blank or contain asterisks (*), angle brackets (< and >), backslashes (\), equal signs (=), commas (,), vertical bars (|), or slashes (/).

  • Example request 1
    POST https://{Endpoint}/v2.0/6a0de1c3-7d74-4f4a-b75e-e57135bd2b97/loadbalancers/7add33ad-11dc-4ab9-a50f-419703f13163/tags/action
    
    {
        "action": "create", 
        "tags": [
            {
                "key": "key1", 
                "value": "value1"
            }, 
            {
                "key": "key2", 
                "value": "value2"
            }
        ]
    }
  • Example request 2
    POST https://{Endpoint}/v2.0/6a0de1c3-7d74-4f4a-b75e-e57135bd2b97/loadbalancers/7add33ad-11dc-4ab9-a50f-419703f13163/tags/action
    
    {
        "action": "delete", 
        "tags": [
            {
                "key": "key1", 
                "value": "value1"
            }, 
            {
                "key": "key2", 
                "value": "value2"
            }
        ]
    }

Response

  • Response parameters

    None

  • Example response 1

    None

  • Example response 2

    None

Response Codes

For details, see Response Codes.