tencent cloud

APIs

DescribeTokenPlanList

Download
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-08-25 10:02:58

1. API Description

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

Query the list of Token Plan package options.

Supports pagination, filtering, and sorting. Root accounts can view all packages, while sub-accounts can only view packages created by themselves. Returned results include the main limit package details associated with each package in the limit center.

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: DescribeTokenPlanList.
Version Yes String Common Params. The value used for this API: 2026-03-22.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
Offset No Integer Offset of paginated query. Default value: 0.
Limit No Integer Number of results returned by paging query. Default value: 20. Maximum value: 100.
Filters.N No Array of RequestFilter Paginate the query filter criteria list. Supported filter fields: TeamId (Package ID), Name (package name), StopReason (disable reason), ProductType (package type).
Sorts.N No Array of RequestSort List of sorting criteria. Supported sorting fields: CreatedAt (creation time) and UpdatedAt (update time). By default, results are sorted by CreatedAt in descending order.

3. Output Parameters

Parameter Name Type Description
TokenPlanSet Array of TokenPlanListItem List of package options.
TotalCount Integer Total number of packages.
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 DescribeTokenPlanList

Test query on the list of TokenPlan package options

Input Example

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

{}

Output Example

{
    "Response": {
        "RequestId": "be515245-e05f-4334-9f9d-6d55db1aa8b5",
        "TokenPlanSet": [
            {
                "ApiKeyMax": 10000,
                "AppId": "176623905",
                "CreatedAt": "2026-04-05T21:06:09+08:00",
                "Creator": "176623905",
                "Name": "my-team-test-1",
                "PrepayResourceID": "pre-123456",
                "Status": "enable",
                "StopReason": "",
                "TeamId": "team-a1b2c3d4",
                "Uin": "214508345",
                "UpdatedAt": "2026-04-07T23:26:01+08:00",
                "ProductType": "enterprise"
            }
        ],
        "TotalCount": 1
    }
}

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

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.InternalError InternalError.InternalError
InvalidParameter.InvalidParameter InvalidParameter.InvalidParameter

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan