Help Center/ Tag Management Service/ API Reference/ API Description/ Resource Tags/ Querying Resource Tags

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

View PDF

Querying Resource Tags

Function

This API is used to query tags of a resource.

Calling Method

For details, see Calling APIs.

URI

GET /v2.0/resources/{resource_id}/tags

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
resource_id	Yes	String	Specifies the resource ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
project_id	No	String	Specifies the project ID. This parameter is mandatory for region-specific resources.
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".

Request Parameters

**Table 3** 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.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
tags	Array of TagVo objects	Specifies resource tags.

**Table 5** TagVo
Parameter	Type	Description
key	String	Specifies the tag key. The value can contain up to 36 characters including letters, digits, hyphens (-), and underscores (_).
value	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.

Status code: 401

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

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

Status code: 403

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

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

Status code: 404

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

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

Status code: 405

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

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

Status code: 406

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

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

Status code: 409

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

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

Status code: 410

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

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

Status code: 412

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

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

Status code: 429

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

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

Status code: 500

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

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

Status code: 501

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

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

Status code: 503

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

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

Example Requests

Querying tags of a resource

GET https://{Endpoint}/v2.0/resources/xxxx/tags?project_id=xxxx&resource_type=disk

Example Responses

Status code: 200

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

Status Codes

Status Code	Description
200	OK
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