自定义监控
自定义监控：查询历史监控数据
接口功能介绍
查询指定自定义监控的时序指标历史监控数据。
接口约束
regionID（资源池）、customItemID（自定义监控项ID）存在。
URI
POST /v4/monitor/query-custom-item-historymetricdata
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| customItemID | 是 | String | 自定义监控项ID | 64ea1664-4347-558e-9bc6-651341c2fa15 | |
| startTime | 是 | String | 查询起始时间戳 | 1667815639 | |
| endTime | 是 | String | 查询结束时间戳 | 1667817639 | |
| dimensions | 否 | Array of Objects | 自定义监控项维度 | dimValue |
表 dimValue
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 是 | String | 维度名称 | host | |
| value | 是 | Array of Strings | 维度值 | ['自定义值1','自定义值2'] |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回对象 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| result | Array of Objects | 返回数据结果 | result |
表 result
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 | |
|---|---|---|---|---|---|
| regionID | String | 所属资源池ID | 81f7728662dd11ec810800155d307d5b | ||
| customItemID | String | 自定义监控项ID | 64ea1664-4347-558e-9bc6-651341c2fa15 | ||
| data | Array of Objects | 监控项值列表 | data | ||
| dimensions | Array of Objects | 自定义监控项维度 | dimValue |
表 data
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| samplingTime | Integer | 监控数据采样时间 | 1667815639 | |
| value | String | 监控项值，具体请参考对应监控项文档 | 524288 |
表 dimValue
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| name | String | 维度名称 | instance | |
| value | String | 维度值 | 127.0.0.1 |
请求示例
请求url
/v4/monitor/query-custom-item-historymetricdata
请求头header
无
请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"startTime":1687158009,
"customItemID":"64ea1664-4347-558e-9bc6-651341c2fa15",
"endTime":1687158309,
"dimensions":[
{
"name":"uuid",
"value":[
"00350e57-67af-f1db-1fa5-20193d873f5d",
"ss-1aytcbcirhhrgkvubwkcmf8lqpsb"
]
},
{
"name":"job",
"value":[
"virtual_machine",
"bare_metal"
]
}
]
}
响应示例
{
"statusCode":800,
"returnObj":{
"result": [
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"customItemID": "64ea1664-4347-558e-9bc6-651341c2fa15",
"data": [
{
"value": "1.32",
"samplingTime": 1687845502
},
{
"value": "0.91",
"samplingTime": 1687845802
}
],
"dimensions": [
{
"name": "uuid",
"value": "ss-1aytcbcirhhrgkvubwkcmf8lqpsb"
},
{
"name": "job",
"value": "bare_metal"
},
{
"name": "sss",
"value": ""
}
]
},
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"customItemID": "64ea1664-4347-558e-9bc6-651341c2fa15",
"data": [
{
"value": "0.3665",
"samplingTime": 1687845502
},
{
"value": "0.3999",
"samplingTime": 1687845802
}
],
"dimensions": [
{
"name": "uuid",
"value": "00350e57-67af-f1db-1fa5-20193d873f5d"
},
{
"name": "job",
"value": "virtual_machine"
},
{
"name": "sss",
"value": ""
}
]
}
]
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.DataQuery.QueryError | 查询数据失败 |
| 其他 | 参见公共错误码说明 |
