实例告警信息汇总统计 - CollectingInstanceAlarmStatistics
调试
您可以在API Explorer中调试该接口。
URI
GET /v3/{project_id}/instances/alarm-statistics
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
start_time | 是 | String | 参数解释: 查询开始时间。 约束限制: 最多可以统计最近7天的数据。 取值范围: 格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 默认取值: 不涉及。 |
top_num | 是 | Integer | 参数解释: 告警数量最多的实例的个数。 约束限制: 不涉及。 取值范围: 取值必须大于0。 默认取值: 5 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
X-Language | 否 | String | 参数解释: 语言。 约束限制: 不涉及。 取值范围:
默认取值: en-us |
响应参数
参数 | 参数类型 | 描述 |
|---|---|---|
total_alarm_count | Integer | 参数解释: 告警总数。 取值范围: 不涉及。 |
ring_percentage | Double | 参数解释: 环比比率。 取值范围: 值为0表示环比没有变化,值为空表示上一周期没有告警。 |
instance_alarm_level_statistics | Array of InstanceAlarmLevelStatistic objects | 参数解释: 实例级别的告警统计。 |
total_alarm_level_statistics | Array of AlarmLevelStatistics objects | 参数解释: 全量告警统计。 |
参数 | 参数类型 | 描述 |
|---|---|---|
instance_id | String | 参数解释: 实例ID。 取值范围: 只能由英文字母、数字组成,且长度为36个字符。 |
instance_name | String | 参数解释: 实例名称。 取值范围: 不涉及。 |
total_count | Integer | 参数解释: 告警总数。 取值范围: 不涉及。 |
alarm_level_statistics | Array of AlarmLevelStatistics objects | 参数解释: 实例级别的各等级告警数量统计。 |
请求示例
告警统计。
GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/9a29cc53af2f499cb48a6d81839264cb/instances/alarm-statistics?start_time=2022-06-22T16:38:02%2B0800&top_num=5
响应示例
{
"total_alarm_count" : 99,
"ring_percentage" : 0.2,
"instance_alarm_level_statistics" : [ {
"instance_id" : "d8e6ca5a624745bcb546a227aa3ae1cfin14",
"instance_name" : "gauss_test",
"total_count" : 50,
"alarm_level_statistics" : [ {
"count" : 5,
"level_name" : "critical"
}, {
"count" : 45,
"level_name" : "notice"
} ]
} ],
"total_alarm_level_statistics" : [ {
"count" : 5,
"level_name" : "critical"
}, {
"count" : 94,
"level_name" : "notice"
} ]
} 状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。

