Batch Adding or Deleting Tags to or from a Transit Subnet

Function

This API is used to batch add or delete tags to or from a transit subnet.

TMS uses this API to batch manage tags of a specified transit subnet.
A transit subnet can have up to 20 tags.

Constraints

This API is idempotent.

If the request body contains duplicate keys, an error is reported.
During tag creation, duplicate keys are not allowed. If a tag to be added has the same key as an existing tag, the tag will be added and overwrite the existing one.
During tag deletion, if some tags to be deleted do not exist, the operation is considered as successful by default. The character set of the tags will not be verified.
The tags structure cannot be missing during deletion. The key cannot be left blank or be an empty string.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/transit-subnets/{resource_id}/tags/action

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.
resource_id	Yes	String	Specifies the transit subnet ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. The value of X-Subject-Token in the response header is the token value.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
action	Yes	String	Specifies the operation. The value can be one of the following: create delete
tags	Yes	Array of Tag objects	Specifies the tag list.

**Table 4** Tag
Parameter	Mandatory	Type	Description
key	Yes	String	Specifies the tag key. A key can contain up to 128 Unicode characters. key cannot be left blank.
value	Yes	String	Specifies the tag value. Each value can contain up to 255 Unicode characters.

Response Parameters

Status code: 204

Tags added or deleted.

None

Example Requests

Adding tags to a transit subnet (Setting action to create and adding two tags: key1, value1 and key2, value2)

POST  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/transit-subnets/56121618-fb0a-4a51-aff0-e2eb9cba4c73/tags/action

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

Deleting tags from a transit subnet (Setting action to delete and deleting two tags: key1, value1 and key2, value2)

POST  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/transit-subnets/56121618-fb0a-4a51-aff0-e2eb9cba4c73/tags/action

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