DescribeResourcesByTags

Last updated: 2019-12-05 17:41:30

PDF

1. API Description

Domain name for API request: tag.tencentcloudapi.com.

This API is used to query resources by tags.

A maximum of 20 requests can be initiated per second for this API.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeResourcesByTags
Version Yes String Common parameter. The value used for this API: 2018-08-13
Region No String Common parameter. This parameter is not required for this API.
TagFilters.N Yes Array of TagFilter Tag filtering arrays.
CreateUin No Integer Tag creator uin.
Offset No Integer Data offset. The default value is 0. Must be an integral multiple of the Limit parameter.
Limit No Integer Page size. The default value is 15.
ResourcePrefix No String Resource prefix.
ResourceId No String Unique resource ID.
ResourceRegion No String The resource’s region.
ServiceType No String Service type.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of results.
Offset Integer Data offset.
Limit Integer Number of entries per page.
Note: This field may return null, indicating that no valid value is found.
Rows Array of ResourceTag Resource tag.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying resources by tags

Input Example

https://tag.tencentcloudapi.com/?Action=DescribeResourcesByTags
&ServiceType=cvm
&ResourcePrefix=instance
&ResourceRegion=ap-beijing
"ResourceId": "ins-1234"
&TagFilters.0.TagKey=key1
&<Common request parameter>

Output Example

{
  "Response": {
    "TotalCount": 1,
    "Offset": 0,
    "Limit": 15,
    "Rows": [
      {
        "InstanceRegion": "ap-guangzhou",
        "ServiceType": "cvm",
        "ResourcePrefix": "instance",
        "ResourceId": "ins-asdfsadf",
        "Tags": [
          {
            "tagKey": "key1",
            " tagValue": "value1",
            "TagKey": "key1",
            "TagValue": "value1"
          }
        ]
      }
    ],
    "RequestId": "5024400f-ae5c-4080-b3ca-f45bf9dae21a"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InvalidParameterValue.TagFilters TagFilters parameter error