查询告警模板详情 - ShowAlarmTemplate

project_id

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

template_id

是

String

参数解释：

告警模板的ID。

约束限制：

不涉及。

取值范围：

以at开头，后跟字母、数字，长度为[2,64]个字符。

默认取值：

不涉及。

X-Auth-Token

否

String

参数解释:

用户Token。

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

template_id

String

参数解释：

告警模板的ID。

取值范围：

以at开头，后跟字母、数字，长度为2到64个字符。

template_name

String

参数解释：

告警模板的名称。

取值范围：

以字母或汉字开头，可包含字母、数字、汉字、_、-、(、)、.、空格，长度为1到128个字符。

template_type

String

参数解释：

模板类型。

取值范围：

• system：默认指标模板。

• custom： 自定义指标模板。

• system_event： 默认事件模板。

• custom_event： 自定义事件模板。

• system_custom_event： 全部事件模板。

create_time

String

参数解释：

告警模板的创建时间 2006-01-02T15:04:05.000Z

取值范围：

不涉及。

template_description

String

参数解释：

告警模板的描述。

取值范围：

长度范围0到256。

policies

Array of AlarmTemplatePolicies objects

告警模板策略列表

namespace

String

参数解释：

查询服务的命名空间，各服务命名空间请参阅支持监控的服务列表。

取值范围：

格式为service.item，如SYS.ECS（弹性云服务器）；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_。字符串的长度必须在3到32个字符之间。

dimension_name

String

参数解释：

资源维度名称，各服务资源的维度名称，请参阅具体云服务的文档。您可以直接从支持监控的服务列表页面导航至相应文档。

取值范围：

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

metric_name

String

参数解释：

资源的监控指标名称，各服务资源的指标名称，请参阅具体云服务的文档。您可以直接从支持监控的服务列表页面导航至相应文档。

取值范围：

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

period

Integer

参数解释：

告警条件判断周期，单位为秒。

取值范围：

• 0：是默认值，事件类告警该字段用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：环比波动

value

Number

参数解释：

告警阈值。具体阈值取值范围请参见附录中各服务监控指标中取值范围，您可以直接从支持监控的服务列表页面导航至相应文档。

取值范围：

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

hierarchical_value

HierarchicalValue object

参数解释：

多层级告警阈值。

unit

String

参数解释：

数据的单位。

取值范围：

长度为0到32个字符。

selected_unit

String

参数解释：

用户在页面中选择的指标单位， 用于后续指标数据回显和计算。字符串最大长度为64。

取值范围：

长度为0到64个字符。

count

Integer

参数解释：

告警连续触发次数。

取值范围：

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

suppress_duration

Integer

参数解释：

告警抑制时间，单位为秒，该字段主要为解决告警频繁的问题。

取值范围：

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

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

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

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

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

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

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

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

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

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

alarm_level

Integer

参数解释：

告警级别。

取值范围：

• 1为紧急

• 2为重要

• 3为次要

• 4为提示

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

参数解释：

用于标识请求异常的具体原因。

取值范围：

字符串长度为0到256个字符。

error_msg

String

参数解释：

用于描述请求异常的具体信息。

取值范围：

字符串长度为0到256个字符。

request_id

String

参数解释：

用于唯一标识一次请求，便于问题追踪。

取值范围：

字符串长度为0到256个字符。

error_code

String

参数解释：

用于标识请求异常的具体原因。

取值范围：

字符串长度为0到256个字符。

error_msg

String

参数解释：

用于描述请求异常的具体信息。

取值范围：

字符串长度为0到256个字符。

request_id

String

参数解释：

用于唯一标识一次请求，便于问题追踪。

取值范围：

字符串长度为0到256个字符。

error_code

String

参数解释：

用于标识请求异常的具体原因。

取值范围：

字符串长度为0到256个字符。

error_msg

String

参数解释：

用于描述请求异常的具体信息。

取值范围：

字符串长度为0到256个字符。

request_id

String

参数解释：

用于唯一标识一次请求，便于问题追踪。

取值范围：

字符串长度为0到256个字符。

error_code

String

参数解释：

用于标识请求异常的具体原因。

取值范围：

字符串长度为0到256个字符。

error_msg

String

参数解释：

用于描述请求异常的具体信息。

取值范围：

字符串长度为0到256个字符。

request_id

String

参数解释：

用于唯一标识一次请求，便于问题追踪。

取值范围：

字符串长度为0到256个字符。

error_code

String

参数解释：

用于标识请求异常的具体原因。

取值范围：

字符串长度为0到256个字符。

error_msg

String

参数解释：

用于描述请求异常的具体信息。

取值范围：

字符串长度为0到256个字符。

request_id

String

参数解释：

用于唯一标识一次请求，便于问题追踪。

取值范围：

字符串长度为0到256个字符。

200

OK

400

参数校验失败

401

未认证

403

认证鉴权失败

404

资源不存在

500

系统内部错误