Help Center/ Tag Management Service/ API Reference/ API Description/ Resource Tags/ Creating Tags in Batches

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

View PDF

Creating Tags in Batches

Function

This API is used to add tags to multiple resources of a cloud service. A maximum of 10 tags can be added to one resource. A maximum of 50 resources can be tagged at a time.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/resource-tags/batch-create

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. TMS is a global service. When calling the Identity and Access Management (IAM) API to obtain a user token, set the scope field to domain. The value of X-Subject-Token in the response header is the user token.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
project_id	No	String	Specifies the project ID. This parameter is mandatory when resource_type is a region-specific service.
resources	Yes	Array of ResourceTagBody objects	Specifies the resource list.
tags	Yes	Array of CreateTagRequest objects	Specifies tags.

**Table 3** ResourceTagBody
Parameter	Mandatory	Type	Description
resource_id	Yes	String	Specifies the resource ID.
resource_type	Yes	String	Specifies the resource type. This parameter is case-sensitive. Examples include: ecs, scaling_group, images, disk,vpcs, security-groups, shared_bandwidth, eip, and cdn. For more details, see "Querying Service Supported by TMS".

**Table 4** CreateTagRequest
Parameter	Mandatory	Type	Description
key	Yes	String	Specifies the tag key. The value can contain up to 36 characters including letters, digits, hyphens (-), and underscores (_).
value	Yes	String	Specifies the tag value. The value can contain up to 43 characters including letters, digits, periods (.), hyphens (-), and underscores (_). It can be an empty string.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
failed_resources	Array of TagCreateResponseItem objects	Specifies the information about resources failed to be tagged.

**Table 6** TagCreateResponseItem
Parameter	Type	Description
resource_id	String	Specifies the resource ID.
resource_type	String	Specifies the resource type.
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 8** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code
error_msg	String	Error message

Status code: 401

**Table 9** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 10** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code
error_msg	String	Error message

Status code: 403

**Table 11** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 12** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code
error_msg	String	Error message

Status code: 404

**Table 13** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 14** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code
error_msg	String	Error message

Status code: 405

**Table 15** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 16** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code
error_msg	String	Error message

Status code: 406

**Table 17** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 18** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code
error_msg	String	Error message

Status code: 409

**Table 19** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 20** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code
error_msg	String	Error message

Status code: 410

**Table 21** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 22** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code
error_msg	String	Error message

Status code: 412

**Table 23** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 24** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code
error_msg	String	Error message

Status code: 429

**Table 25** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 26** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code
error_msg	String	Error message

Status code: 500

**Table 27** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 28** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code
error_msg	String	Error message

Status code: 501

**Table 29** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 30** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code
error_msg	String	Error message

Status code: 503

**Table 31** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 32** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code
error_msg	String	Error message

Example Requests

Adding tags to a resource in batches

POST https://{Endpoint}/v1.0/resource-tags/batch-create

{
  "project_id" : "xxxdcffffffff",
  "resources" : [ {
    "resource_id" : "a28531fa-a8d5-468e-8417-86a80962ee5e",
    "resource_type" : "disk"
  }, {
    "resource_id" : "a28531fa-a8d5-468e-8417-86a8096ddddd",
    "resource_type" : "vpc"
  } ],
  "tags" : [ {
    "key" : "ENV",
    "value" : "dev"
  }, {
    "key" : "DEPT",
    "value" : "pdd"
  } ]
}

Example Responses

Status code: 200

Success

{
  "failed_resources" : [ {
    "resource_id" : "e1eb7c40cbea4c8389cde527594a306d",
    "resource_type" : "disk",
    "error_code" : "TMS.0002",
    "error_msg" : "Bad request"
  } ]
}

Status Codes

Status Code	Description
200	Success
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
405	Method Not Allowed
406	Not Acceptable
409	Conflict
410	Gone
412	Precondition Failed
429	Too Many Requests
500	Internal Server Error
501	Not Implemented
503	Service Unavailable