Updated on 2026-03-16 GMT+08:00

Adding or Deleting Tags in Batches

Function

This API is used to add tags to or delete tags from a specified DB instance in batches. Before calling this API:

Learn how to authenticate it.
Obtain the required region and endpoint.

URI

POST /v3/{project_id}/instances/{instance_id}/tags/action

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
action	Yes	String	Definition Tag operation. Constraints N/A Range create: Add tags. delete: Delete tags. Default Value N/A
tags	Yes	Array of TagItem objects	Definition Tag list. Constraints N/A

**Table 4** TagItem
Parameter	Mandatory	Type	Description
key	Yes	String	Definition Tag key. Constraints N/A Range The value can contain 1 to 128 Unicode characters. It cannot be null, an empty string, or a space. It is case-sensitive and can contain digits, letters, underscores (_), and hyphens (-). Default Value N/A
value	No	String	Definition Tag value. Constraints If action is set to create, this parameter is mandatory. If action is set to delete and value is specified, tags are deleted by key and value. If value is not specified, tags are deleted by key. Range The value can contain 0 to 255 Unicode characters. It can be an empty string but cannot be a space. It is case-sensitive and can contain digits, letters, underscores (_), periods (.), and hyphens (-). Default Value N/A

Response Parameters

Status code: 200

Success.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Adding tags in batches

POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/tags/action
{
  "action" : "create",
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "key" : "key2",
    "value" : "value2"
  } ]
}

Deleting tags in batches

POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/tags/action
{
  "action" : "delete",
  "tags" : [ {
    "key" : "key1"
  }, {
    "key" : "key2",
    "value" : "value2"
  } ]
}

Example Response

None

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Tag Management