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

Batch Adding or Deleting VPC Tags

Function

This API is used to add multiple tags to or delete multiple tags from a VPC 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 operation 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}/vpcs/{vpc_id}/tags/action

Table 1 describes the parameters.

Table 1 Parameter description

Name

Mandatory

Description

project_id

Yes

Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID.

vpc_id

Yes

Specifies the VPC ID, which uniquely identifies the VPC.

Request Parameters

Table 2 Request parameter

Parameter

Type

Mandatory

Description

tags

Array of tag objects

Yes

Specifies the tag objects. 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.
  • Contain up to 128 characters (36 characters on the console).
  • Can contain letters, digits, underscores (_), and hyphens (-).
  • The tag key of a VPC must be unique.

value

String

Yes

  • Specifies the tag value.
  • Contain up to 255 characters (43 characters on the console).
  • Can contain letters, digits, underscores (_), periods (.), and hyphens (-).

Example Request

  • Batch create two tags for a VPC.
    POST https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags/action
    
    {
        "action": "create",
        "tags": [
            {
                "key": "key1",
                "value": "value1"
            },
            {
                "key": "key2",
                "value": "value3"
            }
        ]
    }
  • Batch delete two tags for a VPC.
    POST https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags/action
    
    {
        "action": "delete",
        "tags": [
            {
                "key": "key1",
                "value": "value1"
            },
            {
                "key": "key2",
                "value": "value3"
            }
        ]
    }

Response Parameters

None

Example Response

None

Status Code

See Status Codes.

Error Code

See Error Codes.