修改告警规则策略(全量修改)
功能介绍
修改告警规则策略(全量修改)
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
PUT /v2/{project_id}/alarms/{alarm_id}/policies
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户ID 最小长度：1 最大长度：64 |
|
alarm_id |
是 |
String |
Alarm实例ID 正则匹配：^al([0-9A-Za-z]){22}$ |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Content-Type |
否 |
String |
发送的实体的MIME类型。默认使用application/json; charset=UTF-8。 缺省值：application/json; charset=UTF-8 最小长度：1 最大长度：64 |
|
X-Auth-Token |
否 |
String |
用户Token 最小长度：1 最大长度：16384 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
policies |
是 |
Array of UpdatePolicy objects |
策略信息 数组长度：1 - 50 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
metric_name |
是 |
String |
资源的监控指标名称，必须以字母开头，只能包含0-9/a-z/A-Z/_，字符长度最短为1，最大为64；如：弹性云服务器中的监控指标cpu_util，表示弹性服务器的CPU使用率；文档数据库中的指标mongo001_command_ps，表示command执行频率；各服务的指标名称可查看：“服务指标名称”。 |
|
period |
是 |
Integer |
指标周期，单位是秒； 0是默认值，例如事件类告警该字段就用0即可； 1代表指标的原始周期，比如RDS监控指标原始周期是60s，表示该RDS指标按60s周期为一个数据点参与告警计算；如想了解各个云服务的指标原始周期可以参考“支持服务列表”，300代表指标按5分钟聚合周期为一个数据点参与告警计算。 最小值：0 最大值：86400 枚举值：
|
|
filter |
是 |
String |
聚合方式, 支持的值为(average|min|max|sum) |
|
comparison_operator |
是 |
String |
阈值符号, 支持的值为(>|<|>=|<=|=|!=|cycle_decrease|cycle_increase|cycle_wave);cycle_decrease为环比下降,cycle_increase为环比上升,cycle_wave为环比波动； 指标告警可以使用的阈值符号有>、>=、<、<=、=、!=、cycle_decrease、cycle_increase、cycle_wave； 事件告警可以使用的阈值符号为>、>=、<、<=、=、!=； |
|
value |
否 |
Number |
告警阈值。 |
|
unit |
否 |
String |
单位 |
|
type |
否 |
String |
告警策略类型，默认为空 最小长度：0 最大长度：32 |
|
count |
是 |
Integer |
次数，事件告警时参数值为1~180（包括1和180）；指标告警和站点告警时，次数采用枚举值，枚举值分别为：1、2、3、4、5、10、15、30、60、90、120、180 |
|
suppress_duration |
否 |
Integer |
告警抑制时间，单位为秒，对应页面上创建告警规则时告警策略最后一个字段，该字段主要为解决告警频繁的问题，0代表不抑制，满足条件即告警；300代表满足告警触发条件后每5分钟告警一次； 最小值：0 最大值：86400 枚举值：
|
|
level |
否 |
Integer |
告警级别, 1为紧急，2为重要，3为次要，4为提示。默认值为2。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
policies |
Array of UpdatePolicy objects |
策略信息 数组长度：1 - 50 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
metric_name |
String |
资源的监控指标名称，必须以字母开头，只能包含0-9/a-z/A-Z/_，字符长度最短为1，最大为64；如：弹性云服务器中的监控指标cpu_util，表示弹性服务器的CPU使用率；文档数据库中的指标mongo001_command_ps，表示command执行频率；各服务的指标名称可查看：“服务指标名称”。 |
|
period |
Integer |
指标周期，单位是秒； 0是默认值，例如事件类告警该字段就用0即可； 1代表指标的原始周期，比如RDS监控指标原始周期是60s，表示该RDS指标按60s周期为一个数据点参与告警计算；如想了解各个云服务的指标原始周期可以参考“支持服务列表”，300代表指标按5分钟聚合周期为一个数据点参与告警计算。 最小值：0 最大值：86400 枚举值：
|
|
filter |
String |
聚合方式, 支持的值为(average|min|max|sum) |
|
comparison_operator |
String |
阈值符号, 支持的值为(>|<|>=|<=|=|!=|cycle_decrease|cycle_increase|cycle_wave);cycle_decrease为环比下降,cycle_increase为环比上升,cycle_wave为环比波动； 指标告警可以使用的阈值符号有>、>=、<、<=、=、!=、cycle_decrease、cycle_increase、cycle_wave； 事件告警可以使用的阈值符号为>、>=、<、<=、=、!=； |
|
value |
Number |
告警阈值。 |
|
unit |
String |
单位 |
|
type |
String |
告警策略类型，默认为空 最小长度：0 最大长度：32 |
|
count |
Integer |
次数，事件告警时参数值为1~180（包括1和180）；指标告警和站点告警时，次数采用枚举值，枚举值分别为：1、2、3、4、5、10、15、30、60、90、120、180 |
|
suppress_duration |
Integer |
告警抑制时间，单位为秒，对应页面上创建告警规则时告警策略最后一个字段，该字段主要为解决告警频繁的问题，0代表不抑制，满足条件即告警；300代表满足告警触发条件后每5分钟告警一次； 最小值：0 最大值：86400 枚举值：
|
|
level |
Integer |
告警级别, 1为紧急，2为重要，3为次要，4为提示。默认值为2。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
请求示例
修改名称为disk_device_read_bytes_rate的告警规则策略，修改其指标周期、聚合方式、阀值、单位、次数、告警抑制时间和告警级别等参数。
{
"policies" : [ {
"metric_name" : "disk_device_read_bytes_rate",
"period" : 1,
"filter" : "average",
"comparison_operator" : ">",
"value" : 75,
"unit" : "byte/s",
"count" : 3,
"suppress_duration" : 10800,
"level" : 2
} ]
}
响应示例
状态码： 200
修改成功
{
"policies" : [ {
"metric_name" : "disk_device_read_bytes_rate",
"period" : 1,
"filter" : "average",
"comparison_operator" : ">",
"value" : 75,
"unit" : "byte/s",
"count" : 3,
"type" : "",
"suppress_duration" : 10800,
"level" : 2
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
修改成功 |
|
400 |
参数校验失败 |
|
500 |
系统内部错误 |
错误码
请参见错误码。
