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

Adding Resource Tags in Batches

Function

This API is used to add resource 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, no identity policy-based permissions are required for calling this API.

URI

POST /v5/{project_id}/{resource_type}/{resource_id}/tags/create

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

For details, see Obtaining a Project ID.

resource_type

Yes

String

Resource type.

  • migration: real-time migration.
  • sync: real-time synchronization.
  • cloudDataGuard: real-time disaster recovery.
  • subscription: data subscription.
  • backupMigration: backup migration.
  • replay: traffic replay.

Enumerated values:

  • migration
  • sync
  • cloudDataGuard
  • subscription
  • backupMigration
  • replay

resource_id

Yes

String

Resource ID, that is, the DRS task ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

MIME type of the request body. Use the default value application/json. For APIs used to upload objects or images, the value varies depending on the flow type.

The default value is application/json.

X-Auth-Token

Yes

String

User token obtained from IAM. It is a response to the API for obtaining a user token. After a request is processed, the value of X-Subject-Token in the header is the token value.

X-Language

No

String

Request language type.

Default value: en-us

Enumerated values:

  • en-us
  • zh-cn
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

tags

Yes

Array of objects

Tag list.

For details, see Table 4.

Table 4 Data structure description of field tags

Parameter

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

Minimum length: 1

Maximum length: 128

value

No

String

Tag value. This parameter is optional for deleting a tag.

  • Each tag value can contain a maximum of 255 Unicode characters.
  • The value can contain letters of any language, digits, spaces, and special characters _.:=+-@

Maximum length: 255

Response Parameters

None

Example Request

Adding resource tags in batches for a synchronization task

 https://{endpoint}//v5/5237e10fe9aa4ad5b16b6a5245248314/sync/2f4af282-d13e-4b10-a1eb-609b47fjb201/tags/create

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

Example Response

None

Status Code

Status Code

Description

204

No Content

Error Code

For details, see Error Code.