tencent cloud

APIs

DescribeUsageSummaryList

ダウンロード
フォーカスモード
フォントサイズ
最終更新日: 2026-11-04 21:49:02

1. API Description

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

This API is used to query aggregated details of resource usage, including three types of resources: models, plug-ins, and platforms. It displays indicators such as call count and Token consumption, aggregated by space or application dimension.

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: DescribeUsageSummaryList.
Version Yes String Common Params. The value used for this API: 2026-05-20.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ResourceType Yes Integer

Resource type, limited to MODEL / PLUGIN / PLATFORM

Enumeration itemEnumeration valueDescription
RESOURCE_TYPE_UNSPECIFIED0
RESOURCE_TYPE_MODEL1Model usage
RESOURCE_TYPE_PLUGIN2Plug-in usage (reserved, not currently supported)
RESOURCE_TYPE_PLATFORM (reserved, not currently supported)3Platform feature usage (reserved, not currently supported)
RESOURCE_TYPE_MODEL_CONCURRENCY4Model concurrency limit exceeded (reserved, not currently supported)
RESOURCE_TYPE_KB_CAPACITY5Knowledge base capacity (reserved, not currently supported)
RESOURCE_TYPE_USAGE_SUMMARY6Usage summary (reserved, not currently supported)
RESOURCE_TYPE_RESOURCE_CONSUME7Resource consumption (billing details) (reserved, not currently supported)
TimeRange Yes TimeRange

Query time range (Unix seconds).

ViewScope Yes ViewScope

View scope: corporate view / space view / application view

FilterList.N No Array of Filter

Extended Filter (resource_type=MODEL). Filter combination rule: multiple items use AND, AND value_list within the same item uses OR. Supported Name: MODEL_Name (MODEL Name), user_id (uid), space_id (space id), resource_id/source_id (source id), metric_source_type (metric_source_type_* Enumeration Name OR integer)

PageNumber No Integer

Page number, starting from 0.

PageSize No Integer

Number of items per page. Maximum: 100.

3. Output Parameters

Parameter Name Type Description
TotalCount String

Total record count, used for frontend pagination

UsageSummaryList Array of UsageSummary

Resource usage aggregation details list

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 DescribeUsageSummaryList

Input Example

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

{
    "ResourceType": 1,
    "TimeRange": {
        "EndTime": "1786463999",
        "StartTime": "1786377600"
    },
    "ViewScope": {
        "ViewType": 2,
        "ScopeId": "default_space"
    },
    "PageNumber": 0,
    "PageSize": 10
}

Output Example

{
    "Response": {
        "TotalCount": "86",
        "UsageSummaryList": [
            {
                "Model": {
                    "CallCount": 3200,
                    "IsDefaultKB": false,
                    "ModelName": "hunyuan-turbo",
                    "ResourceConsumptionList": [
                        {
                            "Label": "",
                            "Unit": 0,
                            "Value": 25600000
                        }
                    ]
                },
                "SourceId": "space_abc123",
"SourceName": "Product R&D Space"
                "ViewType": 1
            }
        ],
        "RequestId": "b08c3f61-9655-4fa4-85bb-e35e14e289c4"
    }
}

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 Internal error.
InvalidParameter Parameter error.

ヘルプとサポート

この記事はお役に立ちましたか?

フィードバック