Last updated: 2021-10-08 15:10:50

1. API Description

Domain name for API request:

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.

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: 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 resource list based on tags

Input Example
&<Common request parameters>

Output Example

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

5. Developer Resources


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
AuthFailure.NotEnterpriseAuthorization Not an organizational customer.
FailedOperation.DuplicatedRequest Repeated request. Please check the value of ClientToken.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
MissingParameter Missing parameter.
ResourceNotFound The resource does not exist.
ResourceUnavailable.AccountViolation Restricted resources found in your account. Check your inbox and email for details.
UnknownParameter Unknown parameter.