创建一键告警
功能介绍
创建一键告警
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v2/{project_id}/one-click-alarms
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户ID 最小长度：1 最大长度：64 正则匹配：^[a-zA-Z0-9-]{1,64}$ |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Content-Type |
是 |
String |
发送的实体的MIME类型。默认使用application/json; charset=UTF-8。 缺省值：application/json; charset=UTF-8 最小长度：1 最大长度：64 |
|
X-Auth-Token |
是 |
String |
用户Token 最小长度：1 最大长度：16384 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
one_click_alarm_id |
是 |
String |
系统一键告警ID |
|
dimension_names |
是 |
DimensionNames object |
启用一键告警关联告警规则的维度列表，包括指标告警&事件告警，且至少开启一个 |
|
notification_enabled |
是 |
Boolean |
是否开启告警通知 |
|
alarm_notifications |
否 |
Array of SMNAction objects |
告警触发的动作 |
|
ok_notifications |
否 |
Array of SMNAction objects |
告警恢复触发的动作 |
|
notification_begin_time |
否 |
String |
告警通知开启时间 |
|
notification_end_time |
否 |
String |
告警通知关闭时间 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
metric |
是 |
Array of strings |
启用一键告警关联指标告警规则的维度列表，未指定的维度默认不开启 指标(metric)、事件(event)至少一个不能为空 |
|
event |
是 |
Array of strings |
启用一键告警关联事件告警规则的维度列表，未指定的维度默认不开启，其中""代表全部资源 指标(metric)、事件(event)至少一个不能为空 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
type |
是 |
String |
通知类型,枚举类型：notification,autoscaling,groupwatch,ecsRecovery,contact,contactGroup,iecAction 枚举值：
正则匹配：^(notification|autoscaling|groupwatch|ecsRecovery|contact|contactGroup|iecAction)$ |
|
notification_list |
是 |
Array of strings |
告警状态发生变化时，被通知对象的列表。topicUrn可从SMN获取，具体操作请参考查询Topic列表。当type为notification时，notificationList列表不能为空；当type为autoscaling时，列表必须为[]。 说明：若alarm_action_enabled为true，对应的alarm_actions、ok_actions至少有一个不能为空。若alarm_actions、ok_actions同时存在时，notificationList值保持一致。 数组长度：0 - 20 |
响应参数
状态码： 201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
one_click_alarm_id |
String |
用户开启后关联的一键告警ID |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
请求异常内部业务状态码 最小长度：0 最大长度：256 |
|
error_msg |
String |
请求异常信息 最小长度：0 最大长度：256 |
|
request_id |
String |
请求ID 最小长度：0 最大长度：256 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
请求异常内部业务状态码 最小长度：0 最大长度：256 |
|
error_msg |
String |
请求异常信息 最小长度：0 最大长度：256 |
|
request_id |
String |
请求ID 最小长度：0 最大长度：256 |
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
请求异常内部业务状态码 最小长度：0 最大长度：256 |
|
error_msg |
String |
请求异常信息 最小长度：0 最大长度：256 |
|
request_id |
String |
请求ID 最小长度：0 最大长度：256 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
请求异常内部业务状态码 最小长度：0 最大长度：256 |
|
error_msg |
String |
请求异常信息 最小长度：0 最大长度：256 |
|
request_id |
String |
请求ID 最小长度：0 最大长度：256 |
请求示例
{
"one_click_alarm_id" : "o1234567890123456789012",
"dimension_names" : {
"metric" : [ "disk", "instance_id" ],
"event" : [ "resource_id" ]
},
"notification_enabled" : true,
"alarm_notifications" : [ {
"type" : "notification",
"notification_list" : [ "urn:smn:123" ]
} ],
"ok_notifications" : [ {
"type" : "notification",
"notification_list" : [ "urn:smn:123" ]
} ],
"notification_begin_time" : "00:00",
"notification_end_time" : "23:59"
}
响应示例
状态码： 201
Created
{
"one_click_alarm_id" : "o1234567890123456789012"
}
状态码
|
状态码 |
描述 |
|---|---|
|
201 |
Created |
|
400 |
参数校验失败 |
|
401 |
未认证 |
|
403 |
认证鉴权失败 |
|
500 |
系统内部错误 |
错误码
请参见错误码。
