修改告警规则策略(全量修改)

project_id

是

String

参数解释:

项目ID。用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见“获取项目ID”。

约束限制:

不涉及。

取值范围:

字符串的长度必须在 1 到 64个字符之间。

默认取值:

不涉及。

alarm_id

是

String

参数解释：

告警规则ID。

约束限制：

不涉及。

取值范围：

以al开头，只能由大写字母、小写字母、数字组成，且长度为24个字符。

默认取值：

不涉及。

Content-Type

否

String

参数解释:

发送的实体的MIME类型。

约束限制:

不涉及。

取值范围:

最小字符数量为1，最大为64。

默认取值:

默认使用application/json; charset=UTF-8。

X-Auth-Token

否

String

参数解释:

用户Token。

约束限制:

不涉及。

取值范围:

最小字符数量为1，最大为16384。

默认取值:

不涉及。

policies

是

Array of UpdatePolicyReq objects

参数解释：

策略信息。

约束限制：

策略信息数量最多为50个。

metric_name

是

String

参数解释：

资源的监控指标名称，各服务的指标名称可查看：“服务指标名称”。

约束限制：

不涉及。

取值范围：

必须以字母开头，只能包含0-9/a-z/A-Z/_/-。字符长度最短为1，最大为96。如：弹性云服务器中的监控指标cpu_util，表示弹性服务器的CPU使用率；文档数据库中的指标mongo001_command_ps，表示command执行频率。

默认取值：

不涉及。

extra_info

否

MetricExtraInfo object

参数解释：

策略附加信息。

约束限制：

当策略无附加信息时，不需要传递extra_info。

period

是

Integer

参数解释：

指标周期，单位是秒。如想了解各个云服务的指标原始周期可以参考“支持服务列表”

约束限制：

不涉及。

取值范围：

枚举值。

• 0代表立即触发，仅限事件场景使用。

• 1代表指标的原始周期，比如RDS监控指标原始周期是60s，表示该RDS指标按60s周期为一个数据点参与告警计算。

• 300代表指标按5分钟聚合周期为一个数据点参与告警计算。

• 1200代表指标按20分钟聚合周期为一个数据点参与告警计算。

• 3600代表指标按1小时聚合周期为一个数据点参与告警计算。

• 14400代表指标按4小时聚合周期为一个数据点参与告警计算。

• 86400代表指标按1天聚合周期为一个数据点参与告警计算。

默认取值：

不涉及。

filter

是

String

参数解释：

聚合方式。

约束限制：

不涉及。

取值范围：

average： 平均值，variance：方差，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

参数解释：

告警阈值。具体阈值取值请参见附录中各服务监控指标中取值范围。

约束限制：

单一阈值时value和alarm_level配对使用，当hierarchical_value和value同时使用时以hierarchical_value为准。

取值范围：

最小值为-1.7976931348623157e+108，最大值为1.7976931348623157e+108。

默认取值：

不涉及。

hierarchical_value

否

HierarchicalValue object

参数解释：

多层级告警阈值。

约束限制：

当hierarchical_value和value同时使用时以hierarchical_value为准。

创建或修改告警规则以下2种场景只支持设置一个阈值：

1.告警类型为指标告警且告警策略为所有策略都满足才告警的场景。

2.告警类型为事件告警的场景。

unit

否

String

参数解释：

数据的单位。

约束限制：

不涉及。

取值范围：

长度为[0,32]个字符。

默认取值：

不涉及。

type

否

String

参数解释：

告警策略类型，已废弃，不推荐使用。

约束限制：

不涉及。

取值范围：

只能为auto。

默认取值：

不涉及。

count

是

Integer

参数解释：

告警连续触发次数。

约束限制：

不涉及。

取值范围：

事件告警时参数值为1~180（包括1和180）；指标告警和站点告警时，次数采用枚举值，枚举值分别为：1、2、3、4、5、10、15、30、60、90、120、180。

默认取值：

不涉及。

suppress_duration

否

Integer

参数解释：

告警抑制时间，单位为秒，对应页面上创建告警规则时告警策略最后一个字段，该字段主要为解决告警频繁的问题。

约束限制：

不涉及。

取值范围：

枚举值，只能为0、300、600、900、1800、3600、10800、21600、43200、86400。

• 0：在立即触发场景中，0代表不抑制；在累计触发场景，0代表只告警一次。

• 300代表满足告警触发条件后每5分钟告警一次。

• 600代表满足告警触发条件后每10分钟告警一次。

• 900代表满足告警触发条件后每15分钟告警一次。

• 1800代表满足告警触发条件后每30分钟告警一次。

• 3600代表满足告警触发条件后每60分钟告警一次。

• 10800代表满足告警触发条件后每3小时告警一次。

• 21600代表满足告警触发条件后每6小时告警一次。

• 43200代表满足告警触发条件后每12小时告警一次。

• 86000代表满足告警触发条件后每一天告警一次。

默认取值：

不涉及。

level

否

Integer

参数解释：

告警级别。

约束限制：

不涉及。

取值范围：

只能为1、2、3、4。1为紧急，2为重要，3为次要，4为提示。

默认取值：

2

namespace

否

String

参数解释：

各服务命名空间，请参考“服务命名空间”。产品层级规则需要增加namespace（服务命名空间）和dimension_name（服务维度名称），用于指明策略生效的资源归属。

约束限制：

不涉及。

取值范围：

格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_。长度为[0,32]个字符。

默认取值：

不涉及。

dimension_name

否

String

参数解释：

指标维度名称，各服务资源的指标维度名称可查看：“服务维度名称”。产品层级规则需要增加namespace（服务命名空间）和dimension_name（服务维度名称），用于指明策略生效的资源归属。

约束限制：

不涉及。

取值范围：

目前最大支持4个维度。举例：单维度场景：instance_id；多维度场景：instance_id,disk

默认取值：

不涉及。

origin_metric_name

是

String

参数解释：

原始指标名称。

约束限制：

不涉及。

取值范围：

长度为[0,4096]个字符。

默认取值：

不涉及。

metric_prefix

否

String

参数解释：

指标名称前缀。

约束限制：

不涉及。

取值范围：

长度为[0,4096]个字符。

默认取值：

不涉及。

custom_proc_name

否

String

参数解释：

用户进程名称。

约束限制：

不涉及。

取值范围：

长度为[0,250]个字符。

默认取值：

不涉及。

metric_type

否

String

参数解释：

指标类型。

约束限制：

不涉及。

取值范围：

长度为[0,32]个字符。

默认取值：

不涉及。

critical

否

Double

参数解释：

紧急级别的阈值。

约束限制：

不涉及。

取值范围：

[-1.7976931348623157e+108, 1.7976931348623157e+108]

默认取值：

不涉及。

major

否

Double

参数解释：

重要级别的阈值。

约束限制：

不涉及。

取值范围：

[-1.7976931348623157e+108, 1.7976931348623157e+108]

默认取值：

不涉及。

minor

否

Double

参数解释：

次要级别的阈值。

约束限制：

不涉及。

取值范围：

[-1.7976931348623157e+108, 1.7976931348623157e+108]

默认取值：

不涉及。

info

否

Double

参数解释：

提示级别的阈值。

约束限制：

不涉及。

取值范围：

[-1.7976931348623157e+108, 1.7976931348623157e+108]

默认取值：

不涉及。

policies

Array of UpdatePolicyResp objects

参数解释：

策略信息。

metric_name

String

参数解释：

资源的监控指标名称，各服务的指标名称可查看：“服务指标名称”。

取值范围：

必须以字母开头，只能包含0-9/a-z/A-Z/_/-。字符长度最短为1，最大为96。如：弹性云服务器中的监控指标cpu_util，表示弹性服务器的CPU使用率；文档数据库中的指标mongo001_command_ps，表示command执行频率。

extra_info

MetricExtraInfoResp object

参数解释：

策略附加信息。

period

Integer

参数解释：

指标周期，单位是秒。如想了解各个云服务的指标原始周期可以参考“支持服务列表”。

取值范围：

枚举值。

• 0代表立即触发，仅限事件类告警使用。

• 1代表指标的原始周期，比如RDS监控指标原始周期是60s，表示该RDS指标按60s周期为一个数据点参与告警计算。

• 300代表指标按5分钟聚合周期为一个数据点参与告警计算。

• 1200代表指标按20分钟聚合周期为一个数据点参与告警计算。

• 3600代表指标按1小时聚合周期为一个数据点参与告警计算。

• 14400代表指标按4小时聚合周期为一个数据点参与告警计算。

• 86400代表指标按1天聚合周期为一个数据点参与告警计算。

filter

String

参数解释：

聚合方式。

取值范围：

average： 平均值，variance：方差，min：最小值，max：最大值，sum：求和。

comparison_operator

String

参数解释：

阈值符号。

取值范围：

支持的值为(>|<|>=|<=|=|!=|cycle_decrease|cycle_increase|cycle_wave);cycle_decrease为环比下降,cycle_increase为环比上升,cycle_wave为环比波动。

value

Number

参数解释：

告警阈值。具体阈值取值请参见附录中各服务监控指标中取值范围。

取值范围：

最小值为0，最大值为1.7976931348623157e+108。

hierarchical_value

HierarchicalValueResp object

参数解释：

多层级告警阈值。

取值范围：

创建或修改告警规则以下2种场景只支持设置一个阈值：

1.告警类型为指标告警且告警策略为所有策略都满足才告警的场景。

2.告警类型为事件告警的场景。

unit

String

参数解释：

数据的单位。

取值范围：

长度为[0,32]个字符。

type

String

参数解释：

告警策略类型，已废弃，不推荐使用。

取值范围：

只能为auto。

count

Integer

参数解释：

告警连续触发次数。

取值范围：

事件告警时参数值为1~180（包括1和180）；指标告警和站点告警时，次数采用枚举值，枚举值分别为：1、2、3、4、5、10、15、30、60、90、120、180。

suppress_duration

Integer

参数解释：

告警抑制时间，单位为秒，对应页面上创建告警规则时告警策略最后一个字段，该字段主要为解决告警频繁的问题。

取值范围：

枚举值，只能为0、300、600、900、1800、3600、10800、21600、43200、86400。

• 0：在立即触发场景中，0代表不抑制；在累计触发场景，0代表只告警一次。

• 300代表满足告警触发条件后每5分钟告警一次。

• 600代表满足告警触发条件后每10分钟告警一次。

• 900代表满足告警触发条件后每15分钟告警一次。

• 1800代表满足告警触发条件后每30分钟告警一次。

• 3600代表满足告警触发条件后每60分钟告警一次。

• 10800代表满足告警触发条件后每3小时告警一次。

• 21600代表满足告警触发条件后每6小时告警一次。

• 43200代表满足告警触发条件后每12小时告警一次。

• 86000代表满足告警触发条件后每一天告警一次。

level

Integer

参数解释：

告警级别。

取值范围：

只能为1、2、3、4。1为紧急，2为重要，3为次要，4为提示。

namespace

String

参数解释：

各服务命名空间，请参考“服务命名空间”。产品层级规则增加namespace（服务命名空间）和dimension_name（服务维度名称），用于指明策略生效的资源归属。

取值范围：

格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_。长度为[0,32]个字符。 。

dimension_name

String

参数解释：

指标维度名称，各服务资源的指标维度名称可查看：“服务维度名称”。

取值范围：

目前最大支持4个维度。举例：单维度场景：instance_id；多维度场景：instance_id,disk

origin_metric_name

String

参数解释：

原始指标名称。

取值范围：

长度为[0,4096]个字符。

metric_prefix

String

参数解释：

指标名称前缀。

取值范围：

长度为[0,4096]个字符。

custom_proc_name

String

参数解释：

用户进程名称。

取值范围：

长度为[0,250]个字符。

metric_type

String

参数解释：

指标类型。

取值范围：

长度为[0,32]个字符。

critical

Double

参数解释：

紧急级别的阈值。

取值范围：

[-1.7976931348623157e+108, 1.7976931348623157e+108]

major

Double

参数解释：

重要级别的阈值。

取值范围：

[-1.7976931348623157e+108, 1.7976931348623157e+108]

minor

Double

参数解释：

次要级别的阈值。

取值范围：

[-1.7976931348623157e+108, 1.7976931348623157e+108]

info

Double

参数解释：

提示级别的阈值。

取值范围：

[-1.7976931348623157e+108, 1.7976931348623157e+108]

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

200

修改成功

400

参数校验失败

500

系统内部错误