Updated on 2025-12-09 GMT+08:00

Adding Tags in Batches

Function

This API is used to add tags in batches.

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 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

rds:instance:createTag

write

instance

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

rds:instance:dealTag

-

URI

  • URI format

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

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Definition

    Project ID of a tenant in a region.

    To obtain the value, see Obtaining a Project ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

    instance_id

    Yes

    Definition

    Instance ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

Request

Table 2 Parameters

Parameter

Mandatory

Type

Description

action

Yes

String

Definition

Operation identifier.

Constraints

N/A

Range

The value is case-sensitive and is create for tag creation.

Default Value

N/A

tags

Yes

Array of objects

Definition

Tag list. A maximum of 20 tags can be added for each instance.

For details, see Table 3.

Constraints

N/A

Table 3 tags field data structure description

Parameter

Mandatory

Type

Description

key

Yes

String

Definition

Tag key.

Constraints

N/A

Range

The value must consist of 1 to 128 Unicode characters.

It can contain letters, digits, spaces, and special characters _.:=+-@(). However, it cannot start or end with a space, or start with _sys_.

Default Value

N/A

value

Yes

String

Definition

Tag value.

Constraints

N/A

Range

It can be left blank or contain a maximum of 255 Unicode characters.

It can contain letters, digits, spaces, and special characters _.:=+-@().

Default Value

N/A

Example Request

Add tags key1 and key2 for a DB instance.
POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/tags/action

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

Response

Status Code

Error Code

For details, see Error Codes.