查询服务实例告警信息
功能介绍
该接口用于查询BCS服务的事件、告警数据，可以指定查询时的过滤条件。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v2/{project_id}/blockchains/{blockchain_id}/events
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户从IAM申请到的projectid，一般为32位字符串。 |
|
blockchain_id |
是 |
String |
区块链服务id |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
type |
否 |
String |
查询类型。type=active_alert代表查询活动告警，type=history_alert代表查询历史告警。不传或者传其他值则返回指定查询条件的所有信息。 枚举值：
|
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
time_range |
是 |
String |
timeRange用于指标查询时间范围，主要用于解决客户端时间和服务端时间不一致情况下，查询最近N分钟的数据。另可用于精确查询某一段时间的数据。 |
|
step |
是 |
Long |
统计步长。毫秒数 |
|
search |
否 |
String |
模糊查询匹配字段，可以为空 |
|
metadata_relation |
否 |
Array of EventMetadataRelation objects |
查询条件组合，可以为空 |
|
sort |
否 |
EventResultSort object |
返回列表的排序方式，可以为空 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
metrics |
Array of MetricItemResultAPI objects |
指标对象列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
metric |
MetricDemision object |
指标描述信息 |
|
dataPoints |
Array of MetricDataPoints objects |
监控数据信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
namespace |
String |
命名空间 |
|
metricName |
String |
指标名称 |
|
dimensions |
Array of Dimension objects |
维度列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
timestamp |
Long |
时间戳。 |
|
unit |
String |
指标单位。 |
|
statistics |
Array of StatisticValue objects |
统计方式。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 最小长度：8 最大长度：36 |
|
error_msg |
String |
错误描述 最小长度：2 最大长度：512 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 最小长度：8 最大长度：36 |
|
error_msg |
String |
错误描述 最小长度：2 最大长度：512 |
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 最小长度：8 最大长度：36 |
|
error_msg |
String |
错误描述 最小长度：2 最大长度：512 |
状态码： 404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 最小长度：8 最大长度：36 |
|
error_msg |
String |
错误描述 最小长度：2 最大长度：512 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 最小长度：8 最大长度：36 |
|
error_msg |
String |
错误描述 最小长度：2 最大长度：512 |
请求示例
查询CPU和DISK使用情况告警
{
"metric_names" : [ "cpuUsage", "diskUsedRate" ]
}
响应示例
状态码： 200
Ok
{
"events" : [ {
"annotations" : {
"alarm_probableCause_zh_cn" : "可能原因",
"message" : "告警详情",
"alarm_fix_suggestion_zh_cn" : "修复建议"
},
"attach_rule" : { },
"ends_at" : 0,
"id" : "6775161208461480000",
"metadata" : {
"event_type" : "alarm",
"event_severity" : "Major",
"resource_type" : "blockchain",
"event_name" : "test",
"resource_id" : "d2e2deba-797d-872f-516c-9f96870be67e",
"resource_provider" : "BCS"
},
"starts_at" : 16377362908000,
"timeout" : 60000
} ]
}
状态码： 400
Bad Request
{
"error_code" : "BCS.4001108",
"error_msg" : "metric names is wrong"
}
状态码： 401
Unauthorized
{
"error_code" : "BCS.4010401",
"error_msg" : "Incorrect token or token resolution failed"
}
状态码： 403
Forbidden
{
"error_code" : "BCS.4030403",
"error_msg" : "No permissions to request this method"
}
状态码： 404
Not Found
{
"error_code" : "BCS.4040404",
"error_msg" : "Not Found:the url is not found"
}
状态码： 500
InternalServerError
{
"error_code" : "BCS.5000500",
"error_msg" : "Internal Server Error"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Ok |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
InternalServerError |
错误码
请参见错误码。
