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

Updated on 2025-10-30 GMT+08:00

View PDF

Querying Resources by Tag

Function

This API is used to query resources by tag.

Calling Method

For details, see Calling APIs.

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 Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v1.0/resource-instances/filter

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.
resource_types	Yes	Array of strings	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".
tags	Yes	Array of Tag objects	Specifies tags.
without_any_tag	No	Boolean	If this parameter is set to true, only untagged resources are queried.
offset	No	Integer	Specifies the index position. The query starts from the next data record specified by offset. The value must be a number and cannot be a negative number. The default value is 0.
limit	No	Integer	Specifies the number of records to be queried. If the value is not specified, its default value is 200. The maximum value of limit is 200 and the minimum value is 1.

**Table 3** Tag
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 (_).
values	Yes	Array of strings	Specifies tag values.Each 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 4** Response body parameters
Parameter	Type	Description
resources	Array of Resources objects	Specifies the resource list.
errors	Array of Errors objects	Specifies errors.
total_count	Integer	Specifies the total number of resources queried by tag.

**Table 5** Resources
Parameter	Type	Description
project_id	String	ProjectID
project_name	String	Specifies the Project name.
resource_detail	Object	Specifies the resource details.
resource_id	String	Specifies the resource ID.
resource_name	String	Specifies the resource name.
resource_type	String	Specifies the resource type.
tags	Array of FilterTagResponse objects	Resource Tags

**Table 6** FilterTagResponse
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.

**Table 7** Errors
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.
project_id	String	ProjectID
resource_type	String	Specifies the resource type.

Status code: 400

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

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

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

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

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

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

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

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

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

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

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

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

Status code: 502

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

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

Status code: 503

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

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

Status code: 504

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

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

Example Requests

Querying resources by tag

POST https://v1.0/resource-instances/filter

{
  "project_id" : "e1eb7c40cbea4c8389cde527594a306d",
  "resource_types" : [ "disk", "ecs" ],
  "tags" : [ {
    "key" : "env",
    "values" : [ "dev", "prod" ]
  }, {
    "key" : "test",
    "values" : [ "test" ]
  } ],
  "offset" : 0,
  "limit" : 10
}

Example Responses

Status code: 200

{
  "resources" : [ {
    "project_id" : "e1eb7c40cbea4c8389cde527594a306d",
    "project_name" : "XXXX",
    "resource_type" : "disk",
    "resource_id" : "b621f5ae-b5c1-49d7-a660-752c445434b4",
    "resource_name" : "lhj1-volume-0001",
    "tags" : [ {
      "key" : "ENV",
      "value" : "dev"
    } ]
  }, {
    "project_id" : "e1eb7c40cbea4c8389cde527594a306d",
    "project_name" : "XXXX",
    "resource_type" : "disk",
    "resource_id" : "87c9edc9-f66c-48b8-a22f-372b2e22d579",
    "resource_name" : "lhj2-volume-0002",
    "tags" : [ {
      "key" : "prod",
      "value" : "disk"
    } ]
  } ],
  "errors" : [ {
    "project_id" : "e1eb7c40cbea4c8389cde527594a306d",
    "resource_type" : "disk",
    "error_code" : "TMS.0002",
    "error_msg" : "Bad request"
  } ],
  "total_count" : 2
}

Status Codes

Status Code	Description
200	OK
400	Bad Request
401	Unauthorized
402	Payment Required
403	Forbidden
404	Not Found
405	Method Not Allowed
406	Not Acceptable
407	Proxy Authentication Required
408	Request Timeout
409	Conflict
500	Internal Server Error
501	Not Implemented
502	Bad Gateway
503	Service Unavailable
504	Gateway Timeout