Documentation|Tencent Cloud

Recent Pages

Documentation

DescribeResourceTags

Last updated: 2020-08-07 10:46:15

1. API Description

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

This API is used to query the tags associated with a resource.

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

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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: DescribeResourceTags.
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.
CreateUin	No	Integer	Creator `uin`
ResourceRegion	No	String	Resource region.
ServiceType	No	String	Service type.
ResourcePrefix	No	String	Resource prefix
ResourceId	No	String	Unique resource ID
Offset	No	Integer	Data offset. Default value: 0. It must be an integer multiple of the `Limit` parameter
Limit	No	Integer	Number of entries per page. Default value: 15
CosResourceId	No	Integer	Whether it is a COS resource ID

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 values can be obtained.
Rows	Array of TagResource	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 tags associated with resource

Input Example

https://tag.tencentcloudapi.com/?Action=DescribeResourceTags
&ServiceType=cvm
&ResourcePrefix=instance
&ResourceRegion=ap-beijing
&ResourceId=ins-1234
&<Common request parameters>

Output Example

{
  "Response": {
    "TotalCount": 1,
    "Offset": 0,
    "Limit": 15,
    "Rows": [
      {
        "ServiceType": "cvm",
        "TagKey": "instance",
        "TagKeyMd5": "abced",
        "TagValue": "ins-asdfsadf",
        "TagValueMd5": "abced",
        "ResourceId": "ins-asdfsadf"
      }
    ],
    "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.