Help Center/ Relational Database Service/ API Reference/ API v3 (Recommended)/ Tag Management/ Adding Tags in Batches
Updated on 2024-01-12 GMT+08:00
View PDF

Adding Tags in Batches

Function

This API is used to add tags in batches.

  • Before calling an API, you need to understand the API in Authentication.

URI

  • URI format

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

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID of a tenant in a region.

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

    instance_id

    Yes

    Specifies the DB instance ID.

Request

Parameter description
Table 2 Parameter description

Name

Mandatory

Type

Description

action

Yes

String

Specifies the operation identifier (case sensitive), which is create during the creation operation.

tags

Yes

Array of objects

Specifies the tag list. A maximum of 20 tags can be added for each instance.

For details, see Table 3.
Table 3 tags field data structure description

Name

Mandatory

Type

Description

key

Yes

String

Tag key. It must consist of 1 to 128 Unicode characters, including letters, digits, spaces, and special characters _.:=+-@. However, it cannot start or end with a space, or start with _sys_.

value

Yes

String

Tag value. It can be left blank or contain a maximum of 255 Unicode characters, including letters, digits, spaces, and special characters _.:=+-@.

Example Request

Adding tags key1 and key2 for a DB instance 
{
	"action": "create",
	"tags": [{
		"key": "key1",
		"value": "value1"
	}, {
		"key": "key2",
		"value": "value2"
	}]
}

Response

Status Code

Error Code

For details, see Error Codes.

Parent topic: Tag Management