Adding or Deleting Resource Tags in Batches

Description

This API is used to add or delete tags of the specified instance in batches.

Constraints

A maximum of 20 tags can be added to a DB instance. The tag key must be unique.
- If the request body contains duplicated keys, an error message will be reported when the API is called.
- If the key in the request body is the same as an existing key in the specified instance, the value of the value parameter that corresponds to the existing key is overwritten.
If tags to be deleted do not exist, the operation is considered to be successful by default. The character set of the tags will not be checked. The tag structure in the request body cannot be missing, and the key cannot be left blank or an empty string.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
dds:instance:setTag	tagging	instance	g:EnterpriseProjectId	dds:instance:modify dds:instance:addTag dds:instance:list dds:instance:updateTag dds:instance:deleteTag	-

URI

URI format
POST /v3/{project_id}/instances/{instance_id}/tags/action
URI example
https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/cc6345c64cec47499182467ea0dd432ain02/tags/action

**Table 1** URI parameters
Name	Mandatory	Type	IN	Description
project_id	Yes	string	path	Definition Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
instance_id	Yes	string	path	Definition Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one. Constraints N/A Range N/A Default Value N/A

Request

**Table 2** Request header parameters
Name	Mandatory	Type	IN	Description
X-Auth-Token	Yes	string	header	Definition User token obtained from IAM. For details, see Authentication. Constraints N/A Range N/A Default Value N/A

**Table 3** Parameter description
Name	Type	Mandatory	Description
action	String	Yes	The operation identifier. Range create: indicates to add tags. delete: indicates to delete tags.
tags	Array of objects	Yes	The tag list. For more information, see Table 4. NOTE: When you delete tags, do not check the character set of this parameter.

**Table 4** tags field data structure description
Name	Type	Mandatory	Description
key	String	Yes	The tag key. The key cannot be empty and contains 1 to 128 single-byte characters. The key can contain UTF-8 letters (including Chinese characters), digits, spaces, and the following characters: _.:/=+-@ Do not enter labels starting with _sys_, which are system labels. Character set: 0-9, A-Z, a-z, "_", and "-".
value	String	No	The tag value. The key can contain UTF-8 letters (including Chinese characters), digits, spaces, and the following characters: _.:/=+-@ The value can be empty or null and can contain 0 to 255 single-byte characters. Character set: 0-9, A-Z, a-z, "_", "." and "-". If action is set to create, this parameter is mandatory. If action is set to delete, this parameter is optional. NOTE: If value is specified, tags are deleted by key and value. If value is not specified, tags are deleted by key.

Example Request

Adding two tags in batches

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

Deleting two tags in batches

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

Response

{}

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.