接口功能介绍
调用此接口可根据时间范围查询指定资源池告警次数的变化趋势。
接口约束
regionID(资源池)存在,时间范围不为空,且只接受3个值:7d,24h,6h。
URI
GET /v4/monitor/query-alarm-trend
请求参数
Query参数
参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
---|---|---|---|---|---|
regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 资源池ID | |
timeRange | String | 是 | 24h | 时间范围,7d,24h,6h代表最近7天,最近24小时,最近6小时 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败),默认值:800 | 800 | |
errorCode | String | 失败时的错误代码,参见公共错误码说明 | ||
message | String | 失败时的错误描述,一般为英文描述 | Success | |
msgDesc | String | 失败时的错误描述,一般为中文描述 | 成功 | |
returnObj | Object | 返回对象 | returnObj |
表returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
timeList | Array of Objects | 不同间隔告警数量 | timeCount | |
times | Array of String | 计算趋势的时间间隔 | ["2022-10-10T11:02:00Z","2022-10-10T15:02:00Z"] |
表timeCount
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
timeStamp | String | 时间截至点,说明:timeStamp按升序排列,count数据是按时间区间计算出来的(时间边界下包上不包),timeStamp是取的下区间,他里面统计的是此下区间到他的上区间,他的上区间可参考times里的排序来结合看 | 2022-10-10T11:02:00Z | |
count | Integer | 时间间隔内告警数量 | 0 |
请求示例
GET /v4/monitor/query-alarm-trend?regionID=81f7728662dd11ec810800155d307d5b&timeRange=24h
响应示例
{
"statusCode":800,
"returnObj":{
"timeList":[
{
"timeStamp":"2022-10-10T11:02:00Z",
"count":0
},
{
"timeStamp":"2022-10-10T15:02:00Z",
"count":0
},
{
"timeStamp":"2022-10-10T19:02:00Z",
"count":0
},
{
"timeStamp":"2022-10-10T23:02:00Z",
"count":0
},
{
"timeStamp":"2022-10-11T03:02:00Z",
"count":0
},
{
"timeStamp":"2022-10-11T07:02:00Z",
"count":0
}
],
"times":[
"2022-10-10T11:02:00Z",
"2022-10-10T15:02:00Z",
"2022-10-10T19:02:00Z",
"2022-10-10T23:02:00Z",
"2022-10-11T03:02:00Z",
"2022-10-11T07:02:00Z"
]
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
状态码 | 描述 |
---|---|
200 | 请求成功 |
错误码
errorCode | 描述 |
---|---|
其他 | 参见公共错误码说明 |