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

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

Online Debugging

CLI Examples

View PDF

Querying the Tag List

Function

This API is used to query all tags of a tenant with a specified region and instance type.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/tags

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
resource_type	Yes	String	Resource type.
project_id	Yes	String	Project ID.
tag_types	Yes	String	Tag type.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. TMS is a global service. Set scope to domain when you call the IAM API to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
tags	Array of TagResponse objects	Tag list.
errors	Array of TagListErrorItem objects	Error list.

**Table 4** TagResponse
Parameter	Type	Description
key	String	Tag key.
values	Array of strings	Tag value list.

**Table 5** TagListErrorItem
Parameter	Type	Description
project_id	String	Project ID.
resource_type	String	Resource type.
error_code	String	Error code.
error_msg	String	Error message.

Status code: 400

**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: 401

**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: 403

**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: 404

**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: 405

**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: 406

**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: 409

**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: 410

**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: 412

**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: 429

**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: 500

**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: 501

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

Status code: 503

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

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

Example Requests

Querying the tag list

GET https://v1.0/tags?tag_types=resource&resource_types=vpcs&projects=05c734153980d4202f2ec0176f1ef6b9

Example Responses

Status code: 200

{
  "tags" : [ {
    "key" : "env",
    "value" : [ "test", "prod" ]
  }, {
    "key" : "flag",
    "value" : [ "0", "1" ]
  } ]
}

Status Codes

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