# 实例告警信息汇总统计 - CollectingInstanceAlarmStatistics #### 功能介绍 实例告警信息汇总统计。 - 调用接口前，您需要了解API [认证鉴权](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_011.html)。 - 调用接口前，您需要提前获取到[地区和终端节点](https://developer.huaweicloud.com/endpoint)。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforopenGauss&api=ShowAlarmStatistics)中调试该接口。 #### URI GET /v3/{project_id}/instances/alarm-statistics 表1参数说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | start_time | 是 | String | **参数解释：** 查询开始时间。 **约束限制：** 最多可以统计最近7天的数据。 **取值范围：** 格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 **默认取值** **：** 不涉及。 | | top_num | 是 | Integer | **参数解释：** 告警数量最多的实例的个数。 **约束限制：** 不涉及。 **取值范围：** 取值必须大于0。 **默认取值** **：** 5 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | X-Language | 否 | String | **参数解释：** 指定接口返回信息的语言类型。 **约束限制：** 不涉及。 **取值范围：** - **zh-cn**：中文 - **en-us**：英文 **默认取值** **：** **en-us** | #### 响应参数 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_alarm_count | Integer | **参数解释：** 告警总数。 **取值范围：** 不涉及。 | | ring_percentage | Double | **参数解释：** 环比比率。单位：%。 **取值范围：** 值为0表示环比没有变化，值为空表示上一周期没有告警。 | | instance_alarm_level_statistics | Array of [InstanceAlarmLevelStatistic] objects | **参数解释：** 实例级别的告警统计。 | | total_alarm_level_statistics | Array of [AlarmLevelStatistics] objects | **参数解释：** 全量告警统计。 | 表5InstanceAlarmLevelStatistic | 参数 | 参数类型 | 描述 | |:---|:---|:---| | instance_id | String | **参数解释：** 实例ID。 **取值范围：** 只能由英文字母、数字组成，且长度为36个字符。 | | instance_name | String | **参数解释：** 实例名称。 **取值范围：** 不涉及。 | | total_count | Integer | **参数解释：** 告警总数。 **取值范围：** 不涉及。 | | alarm_level_statistics | Array of [AlarmLevelStatistics] objects | **参数解释：** 实例级别的各等级告警数量统计。 | 表6AlarmLevelStatistics | 参数 | 参数类型 | 描述 | |:---|:---|:---| | count | Integer | **参数解释：** 告警数量。 **取值范围：** 不涉及。 | | level_name | String | **参数解释：** 告警级别名称。 **取值范围：** - critical：严重。 - major：主要。 - minor：次要。 - notice：通知。 | #### 请求示例 告警统计。 ``` GET https://gaussdb-opengauss.cn-north-4.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" } ] } ``` #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。