查询告警配置
功能介绍
查询告警配置。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/alarm-configs
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID。获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
String |
参数解释: 分页偏移量,从0开始,页数减1。 约束限制: 不涉及。 取值范围: 大于等于0。 默认取值: 0 |
limit |
否 |
String |
参数解释: 分页单页大小。 约束限制: 不涉及。 取值范围: 大于0。 默认取值: 不限制。 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
count |
Integer |
参数解释: 告警配置总数。 取值范围: 不涉及。 |
alarm_configs |
Array of AlarmConfigResponse objects |
参数解释: 告警配置列表。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 告警配置ID。 取值范围: 不涉及。 |
alarm_id |
String |
参数解释: 告警ID。 取值范围: 不涉及。 |
alarm_name |
String |
参数解释: 告警名称。 取值范围: 不涉及。 |
name_space |
String |
参数解释: 所属服务。 取值范围: 不涉及。 |
alarm_level |
String |
参数解释: 告警级别。 取值范围: 不涉及。 |
is_user_visible |
String |
参数解释: 用户是否可见。 取值范围: 不涉及。 |
is_converge |
String |
参数解释: 是否覆盖。 取值范围: 不涉及。 |
converge_time |
Integer |
参数解释: 覆盖时间。 取值范围: 不涉及。 |
is_maintain_visible |
String |
参数解释: 运维是否可见。 取值范围: 不涉及。 |
请求示例
https://{Endpoint}/v2/{project_id}/alarm-configs
响应示例
状态码:200
查询告警配置成功。
{ "alarm_configs" : [ { "id" : "fd02e440-b4e2-4d2c-8d98-4d80224cf848", "alarm_id" : "DWS_2000000021_1", "alarm_name" : "文件句柄数使用率超阈值", "name_space" : "dws", "alarm_level" : "urgent", "is_user_visible" : "1", "is_converge" : "0", "converge_time" : 0, "is_maintain_visible" : "0" } ], "count" : 1 }
状态码
状态码 |
描述 |
---|---|
200 |
查询告警配置成功。 |
400 |
请求错误。 |
401 |
鉴权失败。 |
403 |
没有操作权限。 |
404 |
找不到资源。 |
500 |
服务内部错误。 |
503 |
服务不可用。 |