Updated on 2024-04-19 GMT+08:00

Adding a Tag to a Load Balancer

Function

This API is used to add a tag to a specific load balancer for easier management.

Constraints

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

Note the following when you add 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.

URI

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

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

String

Specifies the ID of the load balancer to which a tag is to be added.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

Table 3 Parameter description

Parameter

Mandatory

Type

Description

tag

Yes

Object

Specifies the tag. For details, see Table 4.

Table 4 tag parameter description

Parameter

Mandatory

Type

Description

key

Yes

String

Specifies the tag key.

  • Cannot be left blank.
  • Can contain a maximum of 36 characters.
  • The tag key of a load balancer must be unique.

value

Yes

String

Specifies the tag value.

  • Can contain a maximum of 43 characters.

Response Parameters

None

Example Request

  • Example request
    POST https://{Endpoint}/v2.0/6a0de1c3-7d74-4f4a-b75e-e57135bd2b97/loadbalancers/7add33ad-11dc-4ab9-a50f-419703f13163/tags
    
    {
        "tag": {
            "key": "key1", 
            "value": "value1"
        }
    }

Example Response

  • Example response

    None

Status Code

For details, see Status Codes.