Help Center/ Config/ API Reference/ APIs/ Resource Tags/ Querying Resource Statistics

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

View PDF

Querying Resource Statistics

Function

This API is used to filter resources by tag. TMS enables you to search for resources by tag and displays query results in a list. Using this API requires corresponding services to provide query capabilities. Note that there is a limit in the number of tags for fields: tags, tags_any, not_tags, and not_tags_any.

Note: This API only supports filtering Config resources by tag, and resource_type supports config:policyAssignments, config:aggregators, config:aggregationAuthorizations.

Calling Method

For details, see Calling APIs.

URI

POST /v1/resource-manager/{resource_type}/resource-instances/count

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
resource_type	Yes	String	Resource type.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
without_any_tag	No	Boolean	Tags to be excluded. If this parameter is set to true, all resources that do not have the specified tags will be returned. If this parameter is set to false or is not specified, resources are filtered by tags, matches, and other specified filtering criteria. Default: false
tags	No	Array of Tag objects	Specified tags. Up to 20 tag keys can be specified, and up to 20 values can be specified for each key. Each tag value can be an empty array, but the tag structure cannot be missing. Each tag key must be unique, and the values of the same key must be unique. Resources containing any of the specified tags will be returned. Keys in this list are in an AND relationship while values in each key-value structure is in an OR relationship.If no tag filtering condition is specified, full data is returned.
matches	No	Array of Match objects	Search field. A field contains a key (such as resource_name) and a value. Keys are predefined and must be unique and valid. Whether fuzzy or exact match is used is determined based on the field key. For example, exact match is used for the field key resource_name. If the field value is an empty string, exact match is used. Since very few resources have an empty-string name, an empty list is returned. Exact match is used for the field key resource_id. Currently only resource_name is supported.

**Table 3** Tag
Parameter	Mandatory	Type	Description
key	Yes	String	Tag key. A key can contain up to 128 Unicode characters and cannot be left blank. The system does not verify the character set of the key when searching for resources. The key element cannot be empty, an empty string, or spaces. Before using the key element, delete single-byte character (SBC) spaces before and after the value. Minimum: 1 Maximum: 128
values	Yes	Array of strings	Tag values. A key can contain up to 255 Unicode characters. Before verifying or using the value element, delete single-byte character (SBC) spaces before and after the value. The value can be an empty array but cannot be left blank. If no value is specified, any values are supported. Values are in an Or relationship. The system does not verify the character set of bvaluesb when searching for resources, but only verifies the length. Maximum: 255 Array Length: 0 - 20

**Table 4** Match
Parameter	Mandatory	Type	Description
key	Yes	String	Tag key. Currently, only the resource_name is supported.
value	Yes	String	Tag value. A tag value can contain up to 255 Unicode characters. The character set of a tag value will not be verified by the system. Maximum: 255

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
total_count	Integer	The total number of records.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Example Requests

Querying the Number of Instances By Tags

POST https://{endpoint}/v1/resource-manager/{resource_type}/resource-instances/count

{
  "tags" : [ {
    "key" : "key1",
    "values" : [ "value1", "value2" ]
  }, {
    "key" : "key2",
    "values" : [ "value1", "value2" ]
  } ],
  "matches" : [ {
    "key" : "resource_name",
    "value" : "resource1"
  } ]
}