帮你快速理解、总结文档立即下载
文档中心>API 中心>腾讯云智能体开发平台>资源看板相关接口>查询看板总览KPI卡片

查询看板总览KPI卡片

最近更新时间：2026-08-18 17:30:03
我的收藏

本页目录：

1. 接口描述

接口请求域名： adp.tencentcloudapi.com 。

查询看板总览KPI卡片数据，通过resource_type区分资源看板与业务看板域，返回各域KPI指标列表

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeMetricOverviewList。
Version 是 String 公共参数，本接口取值：2026-05-20。
Region 是 String 公共参数，详见产品支持的 地域列表。
ResourceType 是 Integer

看板域，必填，决定返回哪个域的 KPI 数据

枚举项枚举值描述
RESOURCE_TYPE_UNSPECIFIED0
RESOURCE_TYPE_MODEL1模型用量
RESOURCE_TYPE_PLUGIN2插件用量
RESOURCE_TYPE_PLATFORM3平台功能用量
RESOURCE_TYPE_MODEL_CONCURRENCY4模型并发超限
RESOURCE_TYPE_KB_CAPACITY5知识库容量
RESOURCE_TYPE_USAGE_SUMMARY6用量汇总
RESOURCE_TYPE_RESOURCE_CONSUME7资源消耗（计费明细）

示例值：1
TimeRange 是 TimeRange

查询时间范围（Unix 秒）
ViewScope 是 ViewScope

视图范围：企业视图 / 空间视图
FilterList.N 否 Array of Filter

扩展过滤（resource_type=MODEL）。Filter 组合规则：多项 AND，同项 value_list OR。支持 Name：model_name（模型名）、user_id（用户ID）、space_id（空间ID）、resource_id/source_id（来源ID）、metric_source_type（METRIC_SOURCE_TYPE_* 枚举名或整数）

3. 输出参数

参数名称 类型 描述
MetricList Array of MetricOverview

所有域 Overview 统一出参：KPI 卡片列表，key 字符串标识指标，客户端按 resource_type 解析；key 白名单参考 platform.common.v2.MetricOverview 注释
TotalCount String

总记录数，等于 MetricList 长度，仅为列表接口一致性预留


示例值：12
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 DescribeMetricOverviewList

输入示例

POST / HTTP/1.1
Host: adp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMetricOverviewList
<公共请求参数>

{
    "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"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
中国站