Domain name for API request: adp.intl.tencentcloudapi.com.
Query the overview KPI card data of dashboards, distinguish resource dashboards from business dashboards by resource_type, and return the KPI metric list of each domain.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeMetricOverviewList. | |||||||||||||||||||||||||||
| 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 | Dashboard domain. Required. Determines which domain's KPI data to return.
|
|||||||||||||||||||||||||||
| TimeRange | Yes | TimeRange | Query time range (Unix seconds). |
|||||||||||||||||||||||||||
| ViewScope | Yes | ViewScope | View scope: corporate view / space view |
|||||||||||||||||||||||||||
| FilterList.N | No | Array of Filter | Extended filtering (resource_type=MODEL). Filter combination rule: multiple items use AND, AND value_list within the same item uses OR. Supported Names: 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) |
| Parameter Name | Type | Description |
|---|---|---|
| MetricList | Array of MetricOverview | All domain Overview unified output parameters: KPI Card List, key string identification indicator, client parses by resource_type; for key allowlist, see platform.common.v2.MetricOverview annotation |
| TotalCount | String | Total record count, equal to the length of MetricList, reserved only for list API consistency |
| 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. |
POST / HTTP/1.1
Host: adp.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMetricOverviewList
<Common request parameters>
{
"ResourceType": 1,
"TimeRange": {
"EndTime": "1786463999",
"StartTime": "1786377600"
},
"ViewScope": {
"ViewType": 2,
"ScopeId": "default_space"
}
}{
"Response": {
"MetricList": [
{
"Key": "total_calls",
"Mom": 0.15,
"Unit": 2,
"Value": 12580
}
],
"TotalCount": "12",
"RequestId": "72c3b5b9-9c94-4fb3-9073-498bc50d0981"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
文档反馈