自定义事件
自定义事件:监控详情查询
接口功能介绍
调用此接口可查询自定义事件的监控详情。
接口约束
资源池ID不能为空。
URI
POST /v4/monitor/query-custom-event-data
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
customEventID | 否 | Array of Strings | 自定义事件ID列表 | ['EVENTacd8b6b4610b97d202306301808'] | |
startTime | 否 | Integer | 查询起始时间戳,默认7天前 | 1667815639 | |
endTime | 否 | Integer | 查询截止时间戳,默认当前时间 | 1667827639 | |
pageNo | 否 | Integer | 页码,不传默认为1 | 1 | |
pageSize | 否 | Integer | 每页大小,不传默认为20 | 10 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败),默认值:800 | 800 | |
errorCode | String | 失败时的错误代码,参见公共错误码说明 | ||
message | String | 失败时的错误描述,一般为英文描述 | Success | |
msgDesc | String | 失败时的错误描述,一般为中文描述 | 成功 | |
error | String | 错误码,请求成功时,不返回该字段 | Openapi.Parameter.Error | |
returnObj | Object | 返回参数,参考returnObj对象结构 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
customEventMonitorList | Array of Objects | 自定义事件列表 | customEventMonitor | |
totalCount | Integer | 总记录数 | 2 | |
totalPage | Integer | 总页数 | 1 | |
currentCount | Integer | 当前记录数 | 2 |
表 customEventMonitor
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
regionID | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
customEventID | String | 自定义事件ID | EVENTacd8b6b4610b97d202306301808 | |
name | String | 事件名称 | 主机异常事件 | |
info | String | 事件详情信息 | 主机A因断电异常关闭 | |
clock | Integer | 事件发生时间戳,精确到毫秒 | 1688119722000 |
请求示例
请求url
/v4/monitor/query-custom-event-data
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"startTime": 1688119721,
"endTime": 1688119736,
"pageNo": 1,
"pageSize": 10
}
响应示例
{
"statusCode":800,
"returnObj":{
"customEventMonitorList": [
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"customEventID": "EVENTacd8b6b4610b97d202306301808",
"name": "主机异常事件",
"info": "主机A断电异常关闭",
"clock": 1688119722000
},
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"customEventID": "EVENT789012345678901234567890123",
"name": "网络异常事件",
"info": "网络节点B连接中断",
"clock": 1688119735000
}
],
"totalCount": 2,
"totalPage": 1,
"currentCount": 2
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
状态码 | 描述 |
---|---|
200 | 请求成功 |
错误码
errorCode | 描述 |
---|---|
其他 | 参见公共错误码说明 |