DescribeResourceTagsByTagKeys

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

1. API Description

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

This API is used to get resource tags based on tag keys.

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: DescribeResourceTagsByTagKeys.
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.
ServiceType Yes String Service type
ResourcePrefix Yes String Resource prefix
ResourceRegion Yes String Resource region
ResourceIds.N Yes Array of String Unique resource ID
TagKeys.N Yes Array of String Resource tag key
Limit No Integer Number of entries per page. Default value: 400
Offset No Integer Data offset. Default value: 0. It must be an integer multiple of the Limit parameter

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of results
Offset Integer Data offset
Limit Integer Number of entries per page
Rows Array of ResourceIdTag Resource tag
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting resource tags based on tag keys

Input Example

https://tag.tencentcloudapi.com/?Action=DescribeResourceTagsByTagKeys
&ServiceType=cvm
&ResourcePrefix=instance
&ResourceRegion=ap-beijing
&ResourceIds.0=ins-1234
&TagKeys.0=abc
&TagKeys.1=edf
&<Common request parameters>

Output Example

{
  "Response": {
    "TotalCount": 1,
    "Offset": 0,
    "Limit": 15,
    "Rows": [
      {
        "ResourceId": "ins-asdfsadf",
        "TagKeyValues": [
          {
            "TagKey": "abc",
            "TagValue": "edf"
          }
        ]
      }
    ],
    "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.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

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
InvalidParameter.Tag Tag parameter error.
InvalidParameterValue.RegionInvalid Region error.
InvalidParameterValue.ResourceIdInvalid Resource ID error.
InvalidParameterValue.ResourcePrefixInvalid Resource prefix error.
InvalidParameterValue.TagKeyCharacterIllegal Tag key contains illegal characters.
InvalidParameterValue.TagKeyEmpty Tag key cannot be empty.
InvalidParameterValue.TagKeyLengthExceeded Tag key length exceeds limit.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help