批量更新Prometheus监控告警规则
功能介绍
该接口用于批量启停Prometheus监控告警规则、批量修改Prometheus监控告警规则的告警行动规则。
调用方法
请参见如何调用API。
URI
PUT /v4/{project_id}/alarm-rules/batch-update
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，可以从控制台获取，也可以从调用API处获取。获取方式请参见：获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
action |
是 |
String |
批量操作action：
|
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。获取方式请参见：获取Token。 |
|
Content-Type |
是 |
String |
消息体的类型（格式）。指定类型为“application/json”。 |
|
Enterprise-Project-Id |
否 |
String |
企业项目id。获取方式请参见：获取企业项目ID 。
|
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
alarm_rules |
否 |
Array of BatchAlarmRulesBody objects |
批量启停的告警规则列表。批量启停告警规则时，该参数必填。 |
|
update_action_rules |
否 |
Array of BatchUpdateActionRules objects |
批量修改告警行动规则的告警规则列表。批量修改告警行动规则时，该参数必填。 |
|
update_type |
否 |
String |
更新类型：BATCH_UPDATE_ACTION_RULE。批量修改告警行动规则时，该参数必填。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
alarm_rule_enable |
是 |
Boolean |
当前状态是否启用。 |
|
alarm_rule_id |
是 |
Long |
告警规则id。 |
|
alarm_rule_name |
是 |
String |
告警规则名称。 |
|
alarm_rule_type |
是 |
String |
告警规则类型。
|
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
alarm_rule_id |
是 |
Long |
告警规则id。 |
|
alarm_rule_name |
是 |
String |
告警规则名称。 |
|
alarm_rule_type |
是 |
String |
告警规则类型。 |
|
bind_notification_rule_id |
否 |
String |
待绑定的告警行动规则名称。 |
|
frequency |
是 |
String |
通知频率
|
|
notification_enable |
否 |
Boolean |
是否启用告警通知规则。
如果告警触发“notify_triggered”或告警恢复“notify_resolved”都设置为false（即都不进行告警通知），则notification_enable需设置为false。 |
|
notification_type |
否 |
String |
通知类型。
|
|
notify_resolved |
是 |
Boolean |
告警解决是否通知。
|
|
notify_triggered |
是 |
Boolean |
告警触发是否通知。
|
|
route_group_enable |
否 |
Boolean |
启用告警分组规则。
如果告警触发“notify_triggered”或告警恢复“notify_resolved”都设置为false（即都不进行告警通知），则route_group_enable需设置为false。 |
|
route_group_rule |
否 |
String |
告警分组规则名称。
|
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_message |
String |
错误信息。 |
|
resources |
Array of BatchUpdateItemResult objects |
资源列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
resource_alias |
String |
资源名称别名。 |
|
resource_name |
String |
资源名称。 |
|
ret_status |
String |
资源更新状态。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 最小长度：12 最大长度：12 |
|
error_msg |
String |
错误信息。 最小长度：0 最大长度：1024 |
|
error_type |
String |
错误类型。 最小长度：0 最大长度：128 |
|
trace_id |
String |
请求id。 最小长度：32 最大长度：32 |
请求示例
-
批量启动告警规则。
https://{Endpoint}/v4/{project_id}/alarm-rules/batch-update?action=enable { "alarm_rules" : [ { "alarm_rule_enable" : false, "alarm_rule_id" : 1366, "alarm_rule_name" : "0002", "alarm_rule_type" : "metric" }, { "alarm_rule_enable" : false, "alarm_rule_id" : 1366, "alarm_rule_name" : "0003", "alarm_rule_type" : "metric" } ] } -
批量停止告警规则。
https://{Endpoint}/v4/{project_id}/alarm-rules/batch-update?action=disable { "alarm_rules" : [ { "alarm_rule_enable" : true, "alarm_rule_id" : 1366, "alarm_rule_name" : "0002", "alarm_rule_type" : "metric" }, { "alarm_rule_enable" : true, "alarm_rule_id" : 1366, "alarm_rule_name" : "0003", "alarm_rule_type" : "metric" } ] } -
批量将告警规则的告警通知方式更改为直接告警。
https://{Endpoint}/v4/{project_id}/alarm-rules/batch-update?action=BATCH_UPDATE_ACTION_RULE { "update_action_rules" : [ { "alarm_rule_id" : 1366, "alarm_rule_name" : "0002", "alarm_rule_type" : "metric", "bind_notification_rule_id" : "111111111111111111111111111111111111111111111111111111111111111111", "frequency" : "0", "notification_enable" : true, "notification_type" : "direct", "notify_resolved" : true, "notify_triggered" : true }, { "alarm_rule_id" : 1366, "alarm_rule_name" : "0003", "alarm_rule_type" : "metric", "bind_notification_rule_id" : "111111111111111111111111111111111111111111111111111111111111111111", "frequency" : "0", "notification_enable" : true, "notification_type" : "direct", "notify_resolved" : true, "notify_triggered" : true } ], "update_type" : "BATCH_UPDATE_ACTION_RULE" } -
批量将告警规则的告警通知方式更改为告警降噪。
https://{Endpoint}/v4/{project_id}/alarm-rules/batch-update?action=BATCH_UPDATE_ACTION_RULE { "update_action_rules" : [ { "alarm_rule_id" : 1366, "alarm_rule_name" : "0002", "alarm_rule_type" : "metric", "frequency" : "0", "notification_type" : "alarm_policy", "notify_resolved" : true, "notify_triggered" : true, "route_group_enable" : true, "route_group_rule" : "aom1" }, { "alarm_rule_id" : 1366, "alarm_rule_name" : "0003", "alarm_rule_type" : "metric", "frequency" : "0", "notification_type" : "alarm_policy", "notify_resolved" : true, "notify_triggered" : true, "route_group_enable" : true, "route_group_rule" : "aom1" } ], "update_type" : "BATCH_UPDATE_ACTION_RULE" }
响应示例
状态码：200
OK 请求响应成功。当批量启停告警规则时，返回为null。当批量修改告警规则时，返回以下内容：
{
"error_code" : "200",
"error_message" : "success",
"resources" : [ {
"resource_alias" : "0002",
"resource_name" : "0002",
"ret_status" : "Success"
}, {
"resource_alias" : "0003",
"resource_name" : "0003",
"ret_status" : "Success"
} ]
}状态码：400
BadRequest 非法请求。建议直接修改该请求，不要重试该请求。
{
"error_code" : "AOM.02025026",
"error_msg" : "Input alarmParams is invalid: rule name or type is empty",
"error_type" : "BAD_REQUEST",
"trace_id" : "ff96d66927d839a49fb93d7ccaab3dae"
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK 请求响应成功。当批量启停告警规则时，返回为null。当批量修改告警规则时，返回以下内容： |
|
400 |
BadRequest 非法请求。建议直接修改该请求，不要重试该请求。 |
错误码
请参见错误码。
