查询告警订阅列表
功能介绍
查询订阅告警。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/alarm-subs
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID。获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
String |
参数解释: 分页偏移量,从0开始,页数减1。 约束限制: 不涉及。 取值范围: 大于等于0。 默认取值: 0 |
|
limit |
否 |
String |
参数解释: 分页单页大小。 约束限制: 不涉及。 取值范围: 大于0。 默认取值: 1000 |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Integer |
参数解释: 告警订阅总数。 取值范围: 不涉及。 |
|
alarm_subscriptions |
Array of AlarmSubscriptionResponse objects |
参数解释: 告警订阅列表。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 告警订阅ID。 取值范围: 不涉及。 |
|
name |
String |
参数解释: 告警订阅名称。 取值范围: 不涉及。 |
|
enable |
Integer |
参数解释: 是否开启订阅。 取值范围: 不涉及。 |
|
alarm_level |
String |
参数解释: 告警级别。 取值范围: 不涉及。 |
|
project_id |
String |
参数解释: 项目ID。 取值范围: 不涉及。 |
|
name_space |
String |
参数解释: 所属服务。 取值范围: 不涉及。 |
|
notification_target |
String |
参数解释: 消息主题地址。 取值范围: 不涉及。 |
|
notification_target_name |
String |
参数解释: 消息主题名称。 取值范围: 不涉及。 |
|
notification_target_type |
String |
参数解释: 消息主题类型。 取值范围: 不涉及。 |
|
language |
String |
参数解释: 语言。 取值范围: 不涉及。 |
|
time_zone |
String |
参数解释: 时区。 取值范围: 不涉及。 |
请求示例
https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/alarm-subs
响应示例
状态码:200
查询告警订阅列表成功。
{
"count" : 1,
"alarm_subscriptions" : [ {
"id" : "e8d8359f-b8bd-4b80-bc4d-32c86c7c725e",
"name" : "00",
"enable" : 1,
"language" : "zh-cn",
"alarm_level" : "urgent,important,minor,prompt",
"project_id" : "4cf650fd46704908aa071b4df2453e1e",
"name_space" : "DWS",
"notification_target" : "urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:CGS",
"notification_target_name" : "CGS",
"notification_target_type" : "SMN",
"time_zone" : "GMT+08:00"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询告警订阅列表成功。 |
|
400 |
请求错误。 |
|
401 |
鉴权失败。 |
|
403 |
没有操作权限。 |
|
404 |
找不到资源。 |
|
500 |
服务内部错误。 |
|
503 |
服务不可用。 |