帮你快速理解、总结文档立即下载

查询监控大盘服务列表

最近更新时间:2026-08-12 01:54:06
我的收藏

1. 接口描述

接口请求域名: dlc.tencentcloudapi.com 。

查询监控大盘服务列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:QueryDashboardServiceList。
Version String 公共参数,本接口取值:2021-01-25。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。
Page Integer

页码(默认1)


示例值:1
PageSize Integer

每页数量(默认20)


示例值:20
Filters.N Array of Filter

过滤条件。支持的过滤字段:Keyword(服务名称/模型名称模糊搜索)、Status(服务状态精确匹配,如 Running)、Engine(推理引擎匹配,如 vllm,用于 LLM 推理专项 tab,只要服务有至少一个 deployment 的 engine 匹配即返回)、ResourcePartitionId(资源分区精确匹配)

SortFields.N Array of SortField

排序字段列表(全局排序,支持按指标字段排序)

3. 输出参数

参数名称 类型 描述
Total Integer

匹配过滤条件的服务总数


示例值:8
Page Integer

当前页码


示例值:1
PageSize Integer

每页数量


示例值:20
TotalPages Integer

总页数


示例值:1
Items Array of ServiceMetricsItem

服务监控指标列表

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

4. 示例

示例1 引擎为 xgboost,按 P95LatencyMs 指标倒序排序的示例

输入示例

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

{
    "Page": 1,
    "PageSize": 20,
    "Filters": [
        {
            "Name": "Engine",
            "Operator": "EQ",
            "Values": [
                "xgboost"
            ]
        }
    ],
    "SortFields": [
        {
            "Field": "P95LatencyMs",
            "Order": "DESC"
        }
    ]
}

输出示例

{
    "Response": {
        "Items": [
            {
                "Engine": "xgboost",
                "Metrics": {
                    "CpuUtilization": 0,
                    "ErrorRate": 0,
                    "GpuMemoryTotalMB": 0,
                    "GpuMemoryUsedMB": 0,
                    "GpuUtilization": 0,
                    "MemoryTotalBytes": 0,
                    "MemoryUsedBytes": 0,
                    "NetworkReceiveMBPerSecond": 0,
                    "NetworkSendMBPerSecond": 0,
                    "P95LatencyMs": 0,
                    "P99LatencyMs": 0,
                    "QueueDepth": 0,
                    "RequestsPerSecond": 0,
                    "TimePerOutputTokenP99Ms": 0,
                    "TimeToFirstTokenP99Ms": 0,
                    "TokenThroughput": 0
                },
                "ModelIdentifier": "xgbxgb",
                "ModelName": "xgboost",
                "Replicas": {
                    "Available": 0,
                    "Desired": 1
                },
                "ServiceId": "svc-20260606214706-paqu",
                "ServiceName": "xgboost-xgbxgb",
                "Status": "Failed"
            }
        ],
        "Page": 1,
        "PageSize": 20,
        "Total": 8,
        "TotalPages": 1,
        "RequestId": "5d885425-46a9-488d-b5ea-0ba9958d6ec0"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码