4.4 告警
4.4.2 统计事件告警信息
状态码: 500
InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。
{ "applications/json" : { "error_code" : "AOM.0500",
"error_message" : "SC_INTERNAL_SERVER_ERROR", "error_type" : "SC_INTERNAL_SERVER_ERROR"
}}
状态码: 503
ServiceUnavailable 被请求的服务无效。 建议直接修改该请求,不要重试该请求。
{ "applications/json" : { "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 被请求的服务无效。 建议直接修改该请求,不要 重试该请求。
错误码
请参见错误码。
4.4.2 统计事件告警信息
功能介绍
该接口用于分段统计指定条件下的事件、告警。
调试
您可以在API Explorer中调试该接口。
URI
POST /v2/{project_id}/events/statistic
表4-201 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 租户从IAM申请到的projectid,
一般为32位字符串。
表4-202 Query 参数
参数 是否必选 参数类型 描述
type 否 String 查询类型。type=active_alert代 表查询活动告警,
type=history_alert代表查询历 史告警。不传或者传其他值则返 回指定查询条件的所有信息。
枚举值:
● history_alert
● active_alert
请求参数
表4-203 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 从IAM服务获取的用户Token。
Content-Type 是 String 指定类型为application/json。
表4-204 请求 Body 参数
参数 是否必选 参数类型 描述
time_range 是 String 查询时间范围。 格式:开始时 间UTC毫秒.结束时间UTC毫秒.
时间范围分钟数。开始和结束时 间为-1时,表示最近N分钟,N 为时间范围分钟取值。查询时间 段,如最近五分钟可以表示 为-1.-1.5,固定的时间范围
(2017-08-01 08:00:00到 2017-08-02 08:00:00)可以表 示为1501545600000.15016320000 00.1440。
step 是 Long 统计步长。毫秒数,例如一分钟
则填写为60000。
search 否 String 模糊查询匹配字段,可以为空。
如果值不为空,可以模糊匹配 metadata字段中的必选字段的 值。
sort 否 sort object 返回列表的排序方式,可以为
空。
metadata_rel
ation 否 Array of
RelationMod el objects
查询条件组合,可以为空。
表4-205 sort
参数 是否必选 参数类型 描述
order_by 否 Array of
strings 排序字段列表。会根据列表中定 义顺序对返回列表进行排序。
order 否 String 排序方式枚举值。asc代表正
序,desc代表倒叙。
枚举值:
● asc
● desc
表4-206 RelationModel
参数 是否必选 参数类型 描述
key 否 String 指定查询字段的key,对应
metadata里面的key 。
value 否 Array of
strings 查询条件中指定key的值。
relation 否 String 该条件与其他条件的组合方式。
AND:必须满足所有条件;
OR:可以满足其中一个条件;
NOT:必须不满足所有条件。
枚举值:
● AND
● OR
● NOT
响应参数
状态码: 200
表4-207 响应 Body 参数
参数 参数类型 描述
step Long 统计步长。毫秒数,例如一分钟则填写为
60000。
timestamps Array of
integers 统计结果对应的时间序列。
series Array of EventSeries objects
事件或者告警不同级别相同时间序列对应的统计 结果。
表4-208 EventSeries
参数 参数类型 描述
event_severity String 事件或者告警级别枚举类型。
枚举值:
● Critical
● Major
● Minor
● Info
参数 参数类型 描述 values Array of
integers 事件或者告警统计结果。
状态码: 400
表4-209 响应 Body 参数
参数 参数类型 描述
error_code String 响应码。
枚举值:
● AOM.0403
error_msg String 调用失败响应信息描述。
枚举值:
● Invalid projectId error_type String 调用失败类型。
枚举值:
● Forbidden
状态码: 401
表4-210 响应 Body 参数
参数 参数类型 描述
error_code String 响应码。
枚举值:
● AOM.0403
error_msg String 调用失败响应信息描述。
枚举值:
● Invalid projectId error_type String 调用失败类型。
枚举值:
● Forbidden
状态码: 403
表4-211 响应 Body 参数
参数 参数类型 描述
error_code String 响应码。
枚举值:
● AOM.0403
error_msg String 调用失败响应信息描述。
枚举值:
● Invalid projectId error_type String 调用失败类型。
枚举值:
● Forbidden
状态码: 500
表4-212 响应 Body 参数
参数 参数类型 描述
error_code String 响应码。
枚举值:
● AOM.0403
error_msg String 调用失败响应信息描述。
枚举值:
● Invalid projectId error_type String 调用失败类型。
枚举值:
● Forbidden
状态码: 503
表4-213 响应 Body 参数
参数 参数类型 描述
error_code String 响应码。
枚举值:
● AOM.0403
参数 参数类型 描述
error_msg String 调用失败响应信息描述。
枚举值:
● Invalid projectId error_type String 调用失败类型。
枚举值:
● Forbidden
请求示例
以步长step查询当前时间范围(time_range)内的事件、告警统计信息。
https://{endpoint}/v2/{project_id}/events/statistic { "time_range" : "-1.-1.5",
"step" : 60000 }
响应示例
状态码: 200 OK 请求响应成功。
{ "series" : [ {
"event_severity" : "Minor", "values" : [ 0, 0, 0, 0, 0, 0 ] }, {
"event_severity" : "Info", "values" : [ 0, 0, 0, 0, 0, 0 ] } ],
"step" : 60000,
"timestamps" : [ 1642820700000, 1642820760000, 1642820820000, 1642820880000, 1642820940000, 1642821000000 ]
}
状态码: 400
BadRequest。非法请求。 建议直接修改该请求,不要重试该请求。
{ "applications/json" : { "error_code" : "AOM.0400", "error_message" : "param error", "error_type" : "SC_BAD_REQUEST"
}}
状态码: 401
Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提 供的认证信息不正确或非法。
{ "applications/json" : { "error_code" : "AOM.0401",
"error_message" : "you dont have permission", "error_type" : "SC_UNAUTHORIZED"
}}
状态码: 403
Forbidden 请求被拒绝访问。 返回该状态码,表明请求能够到达服务端,且服务端能 够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接 修改该请求,不要重试该请求。
{ "applications/json" : { "error_code" : "AOM.0403",
"error_message" : "you dont have permission", "error_type" : "SC_FORBIDDEN"
}}
状态码: 500
InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。
{ "applications/json" : { "error_code" : "AOM.0500",
"error_message" : "SC_INTERNAL_SERVER_ERROR", "error_type" : "SC_INTERNAL_SERVER_ERROR"
}}
状态码: 503
ServiceUnavailable 被请求的服务无效。 建议直接修改该请求,不要重试该请求。
{ "applications/json" : { "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 被请求的服务无效。 建议直接修改该请求,不要 重试该请求。
错误码
请参见错误码。