DescribeTagList

PDF

Focus Mode

Font Size

Last updated: 2026-04-24 15:08:32

1. API Description

Domain name for API request: billing.intl.tencentcloudapi.com.

This API is used to get cost allocation tags.

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: DescribeTagList.
Version	Yes	String	Common Params. The value used for this API: 2018-07-09.
Region	No	String	Common Params. This parameter is not required.
Limit	Yes	Integer	Quantity, with the maximum value of 1,000
Offset	Yes	Integer	Pagination offset. Offset=0 indicates the first page. If Limit=100, Offset=100 indicates the second page, Offset=200 indicates the third page, and so on.
TagKey	No	String	Cost allocation tag key, used as fuzzy search
Status	No	Integer	Tag type, enumeration value: 0 ordinary tag, 1 allocation tag, used for filtering. If not passed, get all tag keys.
OrderType	No	String	Sorting method, enumeration value: asc for ascending order, desc for descending order.

3. Output Parameters

Parameter Name	Type	Description
RecordNum	Integer	Total number of records
Data	Array of TagDataInfo	Tag information.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Query tag information

Query tag information

Input Example

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

{
    "Limit": 20,
    "Offset": 0
}

Output Example

{
    "Response": {
        "Data": [
            {
                "Status": 1,
"TagKey": "Test 3",
                "UpdateTime": "2023-02-28 19:22:21"
            },
            {
                "Status": 1,
"TagKey": "Testing 7",
                "UpdateTime": "2023-02-28 19:22:21"
            },
            {
                "Status": 1,
"TagKey": "Testing 8"
                "UpdateTime": "2023-02-28 19:22:21"
            },
            {
                "Status": 0,
"TagKey": "Test4"
            },
            {
                "Status": 0,
"TagKey": "Testing 6"
            }
        ],
        "RecordNum": 5,
        "RequestId": "3cf36106-93e2-498d-a12f-62b3a6d9da34"
    }
}

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
InternalError	Internal error.
InternalError.GatewayError	Gateway error.
InternalError.UnknownError	Undefined exception.
InvalidParameter	Invalid 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

Billing Center