创建自定义告警模板 - CreateAlarmTemplateDeprecated

project_id

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

长度为[1,64]个字符。

默认取值:

不涉及。

Content-Type

否

String

参数解释:

发送的实体的MIME类型。

约束限制:

不涉及。

取值范围:

长度为[1,64]个字符。

默认取值:

默认使用 application/json; charset=UTF-8，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。

X-Auth-Token

否

String

参数解释:

用户Token。

约束限制:

不涉及。

取值范围:

长度为[1,16384]个字符。

默认取值:

不涉及。

template_name

是

String

参数解释

告自定义告警模板名称

约束限制：

不涉及

取值范围：

只能包含0-9/a-z/A-Z/_/-或汉字，长度为1-128。

默认取值：

不涉及

template_description

否

String

参数解释

自定义告警模板详细描述

约束限制：

不涉及

取值范围：

长度范围[0,256]。

默认取值：

不涉及

namespace

是

String

参数解释

创建自定义告警模板选择的资源类型，即服务命名空间，如：选择弹性云服务器，则命名空间为SYS.ECS；各服务命名空间请参阅支持监控的服务列表。

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及

dimension_name

是

String

参数解释

资源类型对应的指标监控维度，选择弹性云服务器，则维度为云服务器，dimension_name值为instance_id；各服务资源的维度名称，请参阅具体云服务的文档。您可以直接从支持监控的服务列表页面导航至相应文档。

约束限制：

不涉及

取值范围：

必须以字母开头，多维度用","分隔，只能包含0-9/a-z/A-Z/_/-，每个维度的最大长度为32。目前最大支持4个维度。字符串总最大长度为131。举例：单维度场景：instance_id；多维度场景：instance_id,disk

默认取值：

不涉及

template_items

是

Array of TemplateItem objects

创建自定义告警模板添加一个或者多个指标的告警规则；目前最多可增加30组告警规则策略。

metric_name

是

String

参数解释

告警模板添加的监控指标，如弹性云服务器可添加的监控指标为cpu_util等；各服务资源的指标名称，请参阅具体云服务的文档。您可以直接从支持监控的服务列表页面导航至相应文档。

约束限制：

不涉及

取值范围：

字符串长度在 1 到 64 之间。

默认取值：

不涉及

condition

是

AlarmTemplateCondition object

创建自定义告警模板的告警策略。

alarm_level

否

Integer

参数解释：

告警级别。

约束限制：

不涉及。

取值范围：

只能为1、2、3、4。

• 1为紧急

• 2为重要

• 3为次要

• 4为提示

默认取值：

不涉及。

comparison_operator

是

String

参数解释：

阈值符号。

约束限制：

指标告警可以使用的阈值符号有>、>=、<、<=、=、!=、cycle_decrease、cycle_increase、cycle_wave； 事件告警可以使用的阈值符号为>、>=、<、<=、=、!=。

取值范围：

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

count

是

Integer

参数解释：

触发告警的连续发生次数。

约束限制：

不涉及。

取值范围：

整数，取值范围[1, 5]。

默认取值：

不涉及。

filter

是

String

参数解释：

数据聚合的方式。

约束限制：

period为1（原始值）时，filter字段不生效，参数值默认为average。period大于1时filter才起作用。

取值范围：

支持 average、variance、min、max、sum。

• average： 平均值

• variance：方差

• min：最小值

• max：最大值

• sum：求和

默认取值：

不涉及。

period

是

Integer

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

unit

否

String

参数解释：

数据的单位。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

value

是

Number

参数解释：

告警阈值。具体阈值取值请参见附录中各服务监控指标中取值范围，如支持监控的服务列表中ECS的CPU使用率cpu_util取值范围可配置80。

约束限制：

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

取值范围：

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

默认取值：

不涉及。

suppress_duration

否

Integer

参数解释：

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

约束限制：

不涉及。

取值范围：

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

• 0：对于指标类告警，0代表告警一次。对于事件类告警，在立即触发场景中，0代表不抑制；在累计触发场景，0代表只告警一次。

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

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

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

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

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

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

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

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

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

默认取值：

不涉及。

template_id

String

参数解释

自定义告警模板创建成功返回的ID

约束限制：

不涉及

取值范围：

以at开头，后跟字母、数字，长度最长为64，如：at1603252280799wLRyGLxnz。

默认取值：

不涉及

-

String

请求错误。

-

String

未提供认证信息，或认证信息错误。

-

String

请求页面被禁止访问。

-

String

请求超出了服务器的等待时间。

-

String

请求过多。

-

String

请求未完成，服务异常。

-

String

系统暂时不可用，请求受限。

201

OK

400

Bad Request

401

Unauthorized

403

Forbidden

408

Request Timeout

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable