接口功能介绍
监控指标查询
接口约束
准备工作，构造请求：在调用前需要了解如何构造请求，详情查看构造请求，认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
URI
GET /v4/cwai/monitor/query_range
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| query | 是 | String | 查询字符串 | 支持查询指标见下 | |
| start | 是 | String | 开始时间 | 1712738540 | |
| end | 是 | String | 结束时间 | 1712739440 | |
| resourceGroupID | 是 | String | 资源组id | xxx-xxx-yyyzzz | |
| regionID | 是 | String | 区域的唯一ID | xxx-xxx-yyyzzz |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 区域的唯一ID | xxx-xxx-yyyzzz |
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 请求成功(800)或者失败(900)，是否必填：是 | 800 | |
| errorCode | String | 错误代码，是否必填：否 | Cwai.Module.xxxx | |
| message | String | 错误信息的描述，是否必填：否 | 请求字段错误 | |
| returnObj | Array of Objects | 返回监控信息列表，是否必填：否 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| values | Array of Objects | 监控信息列表详情，是否必填：是 | value |
表 value
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| value | Array of Strings | [1714025391,"null"]，是否必填：是 |
枚举参数
无
请求示例
请求url
GET https://cwai-global.ctapi.ctyun.cn/v4/cwai/monitor/query_range?resourceGroupID=2bd1d578-7f97-451c-91fb-cb0c798bd28b&query=ctyun_cluster_cpu_used_util&start=1712738540&end=1712739440®ionid=81f7728662dd11ec810800155d307d5b
Content-Type:application/json
regionID:81f7728662dd11ec810800155d307d5b
请求头header
User-Agent : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/110.0"
请求体body
无
响应示例
HTTP/1.1 200 OK
Content-Type:application/json
rspBody: {
"statusCode": 800,
"returnObj": [
{
"metric": {
"__name__": "cpu_util",
"job": "bare_metal",
"instance": "",
"id": "",
"gpu": "",
"display_name": ""
},
"values": [
[
1714025391,
"null"
],
[
1714025451,
"null"
],
[
1714025511,
"null"
],
[
1714025571,
"null"
],
1714025631,
"null"
],
[
1714025691,
"null"
]
]
}
]
}
状态码
请参考 状态码
错误码
请参考 错误码
