Release Notes

Product Introduction

Overview

Instance Type Comparison

Product Features

Application Scenarios

Product Specification Limit

Purchase Guide

Billing Overview

Payment Overdue

Quick Start

Getting Started with Global Accelerator

Getting Started with Global Accelerator 2.0

Operation Guide

GAAP

Global Accelerator 2.0

Quota Description

GAAP

Global Accelerator 2.0

API Documentation

History

Introduction

API Category

Rule APIs

Connection Group APIs

Making API Requests

Origin Server APIs

Listener APIs

Connection APIs

Certificate APIs

Other APIs

Data Types

Error Codes

Agreement

GAAP Service Level Agreement

Data Processing And Security Agreement

FAQs

Glossary

DescribeResourcesByTag

PDF

Focus Mode

Font Size

Last updated: 2025-10-30 21:43:53

1. API Description

Domain name for API request: gaap.intl.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.

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 Params. The value used for this API: DescribeResourcesByTag.
Version	Yes	String	Common Params. The value used for this API: 2018-05-29.
Region	No	String	Common Params. This parameter is not required.
TagKey	Yes	String	Tag key.
TagValue	Yes	String	Tag value.
ResourceType	No	String	Resource types: 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

POST / HTTP/1.1
Host: gaap.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeResourcesByTag
<Common request parameters>

{
    "ResourceType": "Proxy",
    "TagKey": "testkey",
    "TagValue": "test"
}

Output Example

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

5. Developer Resources

SDK

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

Command Line Interface

Tencent Cloud CLI 3.0

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	CAM signature/authentication error.
AuthFailure.NotEnterpriseAuthorization	Not an organizational customer.
AuthFailure.UnauthorizedOperation	The sub-account is not authorized for this operation.
FailedOperation.DuplicatedRequest	Repeated request. Please check the value of ClientToken.
FailedOperation.UserNotConfirmProtocol	Protocol not activated.
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.

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

Global Application Acceleration Platform