查询事件告警信息
功能介绍
该接口用于查询对应用户的事件、告警。
URI
POST /v2/{project_id}/events
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户从IAM申请到的projectid，一般为32位字符串。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
type |
否 |
String |
查询类型。type=active_alert代表查询活动告警，type=history_alert代表查询历史告警。不传或者传其他值则返回指定查询条件的所有信息。 枚举值：
|
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。 |
|
Content-Type |
是 |
String |
指定类型为application/json。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
time_range |
是 |
String |
查询时间范围。格式：开始时间UTC毫秒.结束时间UTC毫秒.时间范围分钟数。开始和结束时间为-1时，表示最近N分钟，N为时间范围分钟取值。查询时间段，如最近五分钟可以表示为-1.-1.5，固定的时间范围（2017-08-01 08:00:00到2017-08-02 08:00:00）可以表示为1501545600000.1501632000000.1440。 |
|
step |
否 |
Long |
统计步长。毫秒数，例如一分钟则填写为60000。 |
|
search |
否 |
String |
模糊查询匹配字段，可以为空。如果值不为空，可以模糊匹配。metadata字段为必选字段。 |
|
sort |
否 |
sort object |
返回列表的排序方式，可以为空。 |
|
metadata_relation |
否 |
Array of RelationModel objects |
查询条件组合，可以为空。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
events |
Array of EventModel objects |
事件或者告警详情。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
starts_at |
Long |
事件或者告警产生的时间，CST毫秒级时间戳。 |
|
ends_at |
Long |
事件或者告警清除的时间，CST毫秒级时间戳，为0时表示未删除。 |
|
timeout |
Long |
告警自动清除时间。毫秒数，例如一分钟则填写为60000。默认清除时间为3天,对应数字为 259200 * 1000（即：3天 * 24小时 * 60分钟 * 60秒 * 1000毫秒）。 |
|
metadata |
Map<String,String> |
事件或者告警的详细信息，为键值对形式。最大可扩展到30个子字段。必须字段为：- event_name：事件或者告警名称,类型为String；- event_severity：事件级别枚举值。类型为String，四种类型 "Critical", "Major", "Minor", "Info"；- event_type：事件类别枚举值。类型为String，event表示事件，alarm表示告警；- resource_provider：事件对应云服务名称。类型为String；- resource_type：事件对应资源类型。类型为String；- resource_id：事件对应资源信息。类型为String; |
|
annotations |
Map<String,String> |
事件或者告警附加字段，可以为空。 |
|
id |
String |
事件或者告警id，系统会自动生成，上报无须填写该字段。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
响应码。 枚举值：
|
|
error_msg |
String |
调用失败响应信息描述。 枚举值：
|
|
error_type |
String |
调用失败类型。 枚举值：
|
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
响应码。 枚举值：
|
|
error_msg |
String |
调用失败响应信息描述。 枚举值：
|
|
error_type |
String |
调用失败类型。 枚举值：
|
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
响应码。 枚举值：
|
|
error_msg |
String |
调用失败响应信息描述。 枚举值：
|
|
error_type |
String |
调用失败类型。 枚举值：
|
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
响应码。 枚举值：
|
|
error_msg |
String |
调用失败响应信息描述。 枚举值：
|
|
error_type |
String |
调用失败类型。 枚举值：
|
状态码： 503
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
响应码。 枚举值：
|
|
error_msg |
String |
调用失败响应信息描述。 枚举值：
|
|
error_type |
String |
调用失败类型。 枚举值：
|
请求示例
查询对应用户的事件、告警列表。
POST https://{endpoint}/v2/{project_id}/events
{
"time_range" : "-1.-1.30",
"metadata_relation" : [ {
"key" : "event_type",
"relation" : "AND",
"value" : [ "alarm" ]
}, {
"key" : "event_severity",
"relation" : "AND",
"value" : [ "Critical", "Major", "Minor", "Info" ]
} ],
"search" : "",
"sort" : {
"order_by" : [ "starts_at" ],
"order" : "desc"
}
}
响应示例
状态码： 200
OK
请求响应成功。
{
"events" : [ {
"annotations" : {
"alarm_probableCause_zh_cn" : "可能原因",
"message" : "告警详情",
"alarm_fix_suggestion_zh_cn" : "修复建议"
},
"arrives_at" : 163773632000,
"attach_rule" : { },
"ends_at" : 0,
"id" : "6775161208461480000",
"metadata" : {
"event_type" : "alarm",
"event_severity" : "Major",
"resource_type" : "vm",
"event_name" : "test",
"resource_id" : "ecs123",
"resource_provider" : "ecs"
},
"policy" : { },
"starts_at" : 16377362908000,
"timeout" : 60000
} ],
"page_info" : {
"current_count" : 2,
"next_marker" : "",
"previous_marker" : ""
}
}
状态码： 400
BadRequest
非法请求。 建议直接修改该请求，不要重试该请求。
{
"error_code" : "AOM.0400",
"error_message" : "param error",
"error_type" : "SC_BAD_REQUEST"
}
状态码： 401
Unauthorized
在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。
{
"error_code" : "AOM.0401",
"error_message" : "you dont have permission",
"error_type" : "SC_UNAUTHORIZED"
}
状态码： 403
Forbidden
请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。
{
"error_code" : "AOM.0403",
"error_message" : "you dont have permission",
"error_type" : "SC_FORBIDDEN"
}
状态码： 500
InternalServerError
表明服务端能被请求访问到，但是不能理解用户的请求。
{
"error_code" : "AOM.0500",
"error_message" : "SC_INTERNAL_SERVER_ERROR",
"error_type" : "SC_INTERNAL_SERVER_ERROR"
}
状态码： 503
ServiceUnavailable
被请求的服务无效。 建议直接修改该请求，不要重试该请求。
{
"error_code" : "AOM.0503",
"error_message" : "SC_NOT_IMPLEMENTED",
"error_type" : "SC_NOT_IMPLEMENTED"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK 请求响应成功。 |
|
400 |
BadRequest 非法请求。 建议直接修改该请求，不要重试该请求。 |
|
401 |
Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 |
|
403 |
Forbidden 请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 |
|
500 |
InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 |
|
503 |
ServiceUnavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。 |
错误码
请参见错误码。
