接口功能介绍
历史监控指标查询
接口约束
华北2
URI
POST /v4/cwai/central/monitor/history-metrics
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| dimension | 是 | String | 查询类型 | 支持查询类型：node、hpfs、cluster、network、pod | |
| step | 是 | String | 步长 | 最小步长60，单位s | |
| start | 是 | String | 开始时间 | 1712738540 | |
| end | 是 | String | 结束时间 | 1712739440 | |
| resourceGroupID | 是 | String | 资源组id | xxx-xxx-yyyzzz | |
| itemNameList | 是 | Array of Strings | 指标名列表，详情见“不同类型支持指标说明” | xxx-xxx-yyyzzz | |
| instanceIDs | 否 | Array of Strings | 实例列表：dimension为resource_group、pod时为非必填，其他情况必填 | xxx-xxx-yyyzzz | |
| pods | 否 | Array of Strings | pod名列表：dimension为pod时必填，其他情况非必填 | xxx-xxx-yyyzzz |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 请求成功(800)或者失败(900)，是否必填：是 | 800 | |
| errorCode | String | 错误代码，是否必填：否 | Cwai.Module.xxxx | |
| message | String | 错误信息的描述，是否必填：否 | 请求字段错误 | |
| returnObj | String | 返回监控信息，是否必填：否 |
枚举参数
无
请求示例
请求url
POST 'https://yunxiao-ui.ctyun.cn:9443/v4/cwai/central/monitor/history-metrics'
Content-Type:application/json
**不同类型支持指标说明**
| 查询类型 | 支持参数 | 说明 |
| -------- | -------------------------------------- | ------------------------------------------ |
| cluster | ctyun_cluster_load1 | CPU 负载 |
| cluster | ctyun_cluster_cpu_used_util | CPU 使用率 |
| cluster | ctyun_cluster_mem_used_util | 内存使用率 |
| cluster | ctyun_cluster_network_transmit_rate | 网络流出速率 |
| cluster | ctyun_cluster_network_receive_rate | 网络流入速率 |
| cluster | ctyun_cluster_node_disk_used_util | 裸金属本地磁盘使用率 |
| cluster | ctyun_cluster_gpu_mem_used | GPU 内存使用量 |
| cluster | ctyun_cluster_gpu_mem_used_util | GPU 内存使用率 |
| cluster | ctyun_cluster_gpu_util | GPU 使用率 |
| cluster | ctyun_cluster_gpu_temp | GPU 最高温度 |
| cluster | ctyun_cluster_gpu_power | GPU 最大功耗 |
| cluster | ctyun_cluster_npu_mem_used | NPU 内存使用量 |
| cluster | ctyun_cluster_npu_mem_used_util | NPU 内存使用率 |
| cluster | ctyun_cluster_npu_util | NPU 使用率 |
| cluster | ctyun_cluster_npu_temp | NPU 最高温度 |
| cluster | ctyun_cluster_npu_power | NPU 最大功耗 |
| node | ctyun_node_load1 | 节点负载 |
| node | ctyun_node_cpu_used_util | 节点CPU使用率 |
| node | ctyun_node_mem_used_util | 节点内存使用率 |
| node | ctyun_node_disk_read_bytes_rate | 节点磁盘读速率 |
| node | ctyun_node_disk_write_bytes_rate | 节点磁盘写速率 |
| node | ctyun_node_pused_disk_space_on | 节点磁盘使用率 |
| node | ctyun_node_network_transmit_rate | 节点网络流出速率 |
| node | ctyun_node_network_receive_rate | 节点网络流入速率 |
| node | ctyun_card_npu_chip_info_health_status | NPU 芯片健康状态 |
| node | ctyun_card_npu_mem_used_util | 节点 NPU 显存使用率 |
| node | ctyun_card_npu_mem_used | 节点 NPU 显存使用量 |
| node | ctyun_card_npu_util | 节点 NPU 使用量 |
| node | ctyun_card_npu_temp | 节点 NPU 温度 |
| node | ctyun_card_npu_power | 节点 NPU 功耗 |
| node | ctyun_card_gpu_mem_used_util | 节点 GPU 显存使用率 |
| node | ctyun_card_gpu_mem_used | 节点 GPU 显存使用量 |
| node | ctyun_card_gpu_util | 节点 GPU 使用量 |
| node | ctyun_card_gpu_temp | 节点 GPU 温度 |
| node | ctyun_card_gpu_power | 节点 GPU 功耗 |
| hpfs | ctyun_fs_read_bw | HPFS 单个文件系统读带宽, 单位：Byte/s |
| hpfs | ctyun_fs_write_bw | HPFS 单个文件系统写带宽, 单位：Byte/s |
| hpfs | ctyun_fs_read_iops | HPFS 单个文件系统读iops, 单位：count |
| hpfs | ctyun_fs_write_iops | HPFS 单个文件系统写iops, 单位：count |
| hpfs | ctyun_fs_capacity_used | HPFS 单个文件系统已使用容量，单位：MB |
| hpfs | ctyun_fs_capacity_usage | HPFS 文件系统容量使用率，单位：% |
| hpfs | ctyun_fs_capacity_total | HPFS 单个文件系统开通总容量 |
| network | ctyun_roce_net_health | 芯片网络健康状态 |
| network | ctyun_roce_status | 芯片网口 Link 状态 |
| network | ctyun_roce_net_in_bandwidth | 芯片网口接收速率 |
| network | ctyun_roce_net_out_bandwidth | 芯片网口发送速率 |
| network | ctyun_roce_pfc_in_count | 接收的 PFC 帧总报文数，60s内接收到的报文数 |
| network | ctyun_roce_pfc_out_count | 发送的 PFC 帧总报文数，60s内接收到的报文数 |
| network | ctyun_roce_in_package_count | 接收的总报文数，60s内接收到的报文数 |
| network | ctyun_roce_out_package_count | 发送的总报文数，60s内接收到的报文数 |
| network | ctyun_roce_in_error_package_count | 接收的坏报文报文数，60s内接收到的报文数 |
| network | ctyun_roce_out_error_package_count | 发送的坏报文报文数，60s内接收到的报文数 |
| network | ctyun_roce_in_cnp_package_count | 接收的 CNP 类型报文数，60s内接收到的报文数 |
| network | ctyun_roce_out_cnp_package_count | 发送的 CNP 类型报文数，60s内接收到的报文数 |
| network | ctyun_roce_package_retry_count | 重试报文数，60s内接收到的报文数 |
| pod | ctyun_pod_cpu_util | pod CPU使用率 |
| pod | ctyun_pod_cpu_used | pod CPU使用量 |
| pod | ctyun_pod_mem_util | pod内存使用率 |
| pod | ctyun_pod_mem_used | pod内存使用量 |
| pod | ctyun_pod_network_receive_rate | pod网络接收速率 |
| pod | ctyun_pod_network_transmit_rate | pod网络发送速率 |
| pod | ctyun_pod_npu_mem_util | pod NPU内存使用率 |
| pod | ctyun_pod_npu_mem_used | pod NPU内存使用量 |
| pod | ctyun_pod_npu_util | pod NPU使用率 |
| pod | ctyun_pod_npu_power | pod NPU功率 |
| pod | ctyun_pod_npu_temp | pod NPU温度 |
| pod | ctyun_pod_gpu_mem_util | pod GPU内存使用率 |
| pod | ctyun_pod_gpu_mem_used | pod GPU内存使用量 |
| pod | ctyun_pod_gpu_util | pod GPU使用率 |
| pod | ctyun_pod_gpu_power | pod GPU功率 |
| pod | ctyun_pod_gpu_temp | pod GPU温度 |
请求头header
User-Agent : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/110.0"
请求体body
{
"itemNameList": [
"npu_chip_info_link_status"
],
"start": 1727246685,
"end": 1727247585,
"step": "60",
"dimension": "node",
"instanceIDs": [
"ss-ilzmkjewjsgev0fz1vzxuv5ulerj"
],
"resourceGroupIDs": [
"455cce64-89ab-43dd-a984-97535ec5c339"
],
"regionID": "200000004062"
}
响应示例
HTTP/1.1 200 OK
Content-Type:application/json
rspBody:
{
"statusCode": 800,
"message": "成功",
"returnObj": {
"npu_chip_info_link_status": [
{
"metric": {
"__name__": "npu_chip_info_link_status",
"id": "ss-ilzmkjewjsgev0fz1vzxuv5ulerj",
"instance": ""
},
"itemDesc": "npu芯片网口Link状态",
"values": [
[
1727246685,
"null"
],
[
1727246745,
"1"
],
[
1727246805,
"1"
],
[
1727246865,
"1"
],
[
1727246925,
"1"
],
[
1727246985,
"1"
],
[
1727247045,
"1"
],
[
1727247105,
"1"
],
[
1727247165,
"1"
],
[
1727247225,
"1"
],
[
1727247285,
"1"
],
[
1727247345,
"1"
],
[
1727247405,
"1"
],
[
1727247465,
"1"
],
[
1727247525,
"1"
],
[
1727247585,
"1"
]
]
}
]
}
}
状态码
请参考 状态码
错误码
请参考 错误码
