Batch Creating or Deleting Subnet Tags

Function

This API is used to add multiple tags to or delete multiple tags from a subnet at a time.

This API is idempotent.

If there are duplicate keys in the request body when you add tags, an error is reported.

During tag creation, duplicate keys are not allowed. If a key already exists in the database, its value will be overwritten by the new duplicate key.

During tag deletion, if some tags do not exist, the deletion is considered to be successful by default. The character set of the tags will not be checked. When you delete tags, the tag structure cannot be missing, and the key cannot be left blank or be an empty string.

URI

POST /v2.0/{project_id}/subnets/{subnet_id}/tags/action

Table 1 describes the parameters.

Table 1 Parameter description

Name

Mandatory

Description

project_id

Yes

Specifies the project ID.

subnet_id

Yes

Specifies the subnet ID, which uniquely identifies the subnet.

If you use the management console, the value of this parameter is the Network ID value.

Request Message

Request parameter

Table 2 Request parameter

Parameter

Type

Mandatory

Description

tags

Array of tag objects

Yes

Specifies the tag object list. For details, see Table 3.

action

String

Yes

Specifies the operation. Possible values are as follows:

  • create
  • delete
Table 3 tag objects

Attribute

Type

Mandatory

Description

key

String

Yes
  • Specifies the tag key.
  • Cannot be left blank.
  • Can contain a maximum of 36 characters.
  • Can contain only the following character types:
    • Uppercase letters
    • Lowercase letters
    • Digits
    • Special characters, including hyphens (-) and underscores (_)
  • The tag key of a VPC must be unique.

value

String

Yes
  • Specifies the tag value.
  • Can contain a maximum of 43 characters.
  • Can contain only the following character types:
    • Uppercase letters
    • Lowercase letters
    • Digits
    • Special characters, including hyphens (-) and underscores (_)

Request example 1: Creating tags in batches

POST https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags/action

{
    "action": "create",
    "tags": [
        {
            "key": "key1",
            "value": "value1"
        },
        {
            "key": "key2",
            "value": "value3"
        }
    ]
}

Request example 2: Deleting tags in batches

POST https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags/action

{
    "action": "delete",
    "tags": [
        {
            "key": "key1",
            "value": "value1"
        },
        {
            "key": "key2",
            "value": "value3"
        }
    ]
}

Response Message

Response parameter

None

Example response

None

Status Code

See Status Codes.

Error Code

See Error Codes.

Parent topic: Subnet Tag Management