DescribeResourcesByTag

Last updated: 2020-04-17 15:10:08

1. API Description

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

This API (DescribeResourcesByTag) is used to query corresponding resource information by tags, including connection, connection group, and origin server.

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: DescribeResourcesByTag.
Version Yes String Common parameter. The value used for this API: 2018-05-29.
Region No String Common parameter. This parameter is not required for this API.
TagKey Yes String Tag key.
TagValue Yes String Tag value.
ResourceType No String Resource type, including:
Proxy (connection);
ProxyGroup (connection group);
RealServer (origin server).
If this field is not specified, all resources with the tag will be queried.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total resources
ResourceSet Array of TagResourceInfo Resource list corresponding to the tag
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Pulling a Resource List Based on Tags

Input Example

https://gaap.tencentcloudapi.com/?Action=DescribeResourcesByTag
&TagKey=testkey
&TagValue=test
&ResourceType=Proxy
&<Common request parameters>

Output Example

{
  "Response": {
    "ResourceSet": [
      {
        "ResourceType": "Proxy",
        "ResourceId": "link-12345678"
      }
    ],
    "TotalCount": 1,
    "RequestId": "5c680029-66b2-4be8-9630-7bd316ce70dd"
  }
}

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
FailedOperation.DuplicatedRequest Repeated request. Please check the value of ClientToken.
InternalError Internal error
InvalidParameter Parameter error
InvalidParameterValue Parameter value error
MissingParameter Parameter missing
ResourceNotFound Resource does not exist
UnknownParameter Unknown parameter error

Was this page helpful?

Was this page helpful?

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