事件监控
事件监控:数据统计
接口功能介绍
根据指定时间段统计指定事件发生情况。
接口约束
regionID、eventName、startTime、endTime、period、dimension、service存在。
URI
POST /v4/monitor/events/count-data
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池 ID | 81f7728662dd11ec810800155d307d5b | |
eventName | 是 | String | 本参数表示事件指标,事件指标见查询事件接口返回。 | migration_event_start | |
service | 是 | String | 服务,见事件监控:查询服务维度接口返回。 | ecs | |
dimension | 是 | String | 维度,见事件监控:查询服务维度接口返回。 | ecs | |
startTime | 是 | Integer | 查询起始时间戳 | 1647424660 | |
endTime | 是 | Integer | 查询截止时间戳 | 1647424660 | |
period | 是 | Integer | 统计周期 | 300 | |
resGroupID | 否 | String | 资源分组ID,在资源分组事件时传入 | 9cb2b330-1dd8-5ec4-9c6d-b07fe65a9aca |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败),默认值:800 | 800 | |
errorCode | String | 失败时的错误代码,参见公共错误码说明 | ||
message | String | 失败时的错误描述,一般为英文描述 | Success | |
msgDesc | String | 失败时的错误描述,一般为中文描述 | 成功 | |
error | String | 错误码,请求成功时,不返回该字段 | Openapi.Parameter.Error | |
returnObj | Object | 返回对象 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
data | Array of Objects | 事件统计信息 | dataObj |
表 dataObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
value | Integer | 事件统计数量 | 5 | |
samplingTime | Integer | 事件统计采样时间,秒级 | 1667815639 |
请求示例
请求url
/v4/monitor/events/count-data
请求头header
无
请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"dimension":"ecs",
"service":"ecs",
"eventName":"migration_event_start",
"startTime":1647424360,
"endTime":1647424660,
"period":300
}
响应示例
{
"statusCode":800,
"returnObj":{
"data":[
{
"samplingTime":1647424360,
"value":5
},
{
"samplingTime":1647424660,
"value":6
}
]
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
状态码 | 描述 |
---|---|
200 | 请求成功 |
错误码
errorCode | 描述 |
---|---|
Monitor.EventMonitor.DimensionNotSupport | 该维度的事件暂不支持 |
其他 | 参见公共错误码说明 |