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

查询资源分区监控实时概览

最近更新时间:2026-11-17 01:54:00
我的收藏

1. 接口描述

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

查询指定资源分区的监控实时概览。指标命名规则 [queue_ 前缀]_<资源>_<K8s/Kueue 概念>[_business 后缀]:_business 后缀 = 计费口径(仅 ray-head/ray-worker 业务容器 limits,配额扣减与展示默认用);无后缀 = K8s 实事口径(全部容器,对照排查用)。GPU 类指标按 GPU 卡型拆分多条 MetricValue(Labels.GpuType 区分);gpu_limit_business 在 Prometheus 空集(无作业)时按分区配额卡型逐卡型补 value=0。分区维度额外含排队卡片指标(pending_workloads / admission_wait_seconds / top_queue_by_cpu 资源占用最高的队列,detail 表口径:按队列聚合活跃 Pod 的 cpu_limit 取 Top1,作业结束即归零,队列名见 Labels.QueueName(已截去 namespace 前缀与 -lq 后缀);Kueue 预留口径对照见 top_queue_by_cpu_reserved)与按量月消耗卡片(postpay_month_consumed_total)。携带 QueueName 时切换为资源组维度,指标集双向隔离(详见 QueueName 参数说明)

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

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

2. 输入参数

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

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

资源分区编码


示例值:dlc-p-vboauljz
QueueName 否 String

资源组(队列)名称,可选。不传时返回 partition 维度指标(含 pending_workloads / admission_wait_seconds / top_queue_by_cpu 排队卡片、_limit_business 计费口径已使用量、quota_total 配额、postpay_month_consumed_total 当月已消耗);传入时切换为 queue 维度:仅返回 queue 前缀指标(queue_limit_business 计费口径已使用量 / queue_admitted Kueue 对照口径 / queue_pending_workloads / queue_admission_wait_seconds)+ 该队列的配额指标(cpu_quota_total / memory_quota_total / gpu_quota_total / vram_quota_total,数值来自队列的 resource_usage 而非分区 resource_config)+ postpay_month_consumed_total


示例值:default
MetricKeys.N 否 Array of String

指标 key 过滤列表,为空则返回全部指标


示例值:["pending_workloads"]

3. 输出参数

参数名称 类型 描述
Metrics Array of MetricValue

监控指标列表

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

4. 示例

示例1 查询排队任务数

输入示例

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

{
    "MetricKeys": [
        "pending_workloads"
    ],
    "PartitionCode": "dlc-p-vboauljz"
}

输出示例

{
    "Response": {
        "Metrics": [
            {
                "MetricKey": "pending_workloads",
                "Unit": "count",
                "ResourceType": "kueue",
                "Value": 0
            }
        ],
        "RequestId": "1ed50a8c-1ffb-4023-b906-7a9c1730d51f"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.MonitorDisabled 资源包监控功能未启用
FailedOperation.MonitorPrometheusQueryFailed 查询失败
InternalError 内部错误。
ResourceNotFound.MonitorPartition ResourceNotFound.MonitorPartition
ResourceNotFound.MonitorQueue 资源包不存在或状态非有效