# 创建自定义告警模板 - CreateAlarmTemplate #### 功能介绍 创建自定义告警模板 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CES/doc?api=CreateAlarmTemplate&version=v2)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ces/ces_03_0045.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | ces:customAlarmTemplates:create | Write | - | g:EnterpriseProjectId | - | - | #### URI POST /v2/{project_id}/alarm-templates 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**: 项目ID。用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-ces/ces_03_0057.html)。 **约束限制**: 不涉及。 **取值范围**: 字符串的长度必须在 1 到 64个字符之间。 **默认取值**: 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**: 用户Token。Token认证，具体操作请参考[认证鉴权](https://support.huaweicloud.com/api-ces/ces_03_0011.html)。 **约束限制**: 不涉及。 **取值范围**: 最小字符数量为1，最大为16384。 **默认取值**: 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | template_name | 是 | String | **参数解释**： 告警模板的名称。 **约束限制**： 不涉及。 **取值范围**： 以字母或汉字开头，可包含字母、数字、汉字、_、-，长度为\[1,128\]个字符。 **默认取值**： 不涉及。 | | template_type | 否 | Integer | **参数解释**： 自定义告警模板类型。 **约束限制**： 不涉及。 **取值范围**： 枚举值。 - 0：指标。 - 2： 事件。 **默认取值**： 0 | | template_description | 否 | String | **参数解释**： 告警模板的描述 **约束限制**： 不涉及。 **取值范围**： 长度范围\[0,256\]。 **默认取值**： 空字符串。 | | is_overwrite | 否 | Boolean | **参数解释**： 是否对模板名称已经存在的告警模板进行覆盖。 **约束限制**： 不涉及。 **取值范围**： 布尔值。 - true:覆盖同名告警模板。 - false：不覆盖，新建告警模板。 **默认取值**： false | | policies | 是 | Array of [Policies] objects | **参数解释**： 告警模板策略列表。 **约束限制**： 不超过1000个策略。 | 表4Policies | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | namespace | 是 | String | **参数解释**： 查询服务的命名空间，各服务命名空间请参阅[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)。 **约束限制**： 不涉及。 **取值范围**： 格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_。字符串的长度必须在 3 到 32个字符之间。 **默认取值**： 不涉及。 | | dimension_name | 否 | String | **参数解释**： 资源维度。 **约束限制**： 事件告警模板DimensionName为空 **取值范围**： 必须以字母开头，多维度用","分隔，只能包含0-9/a-z/A-Z/_/-，每个维度的最大长度为32。目前最大支持4个维度。字符串总最大长度为131。举例：单维度场景：instance_id；多维度场景：instance_id,disk **默认取值**： 不涉及。 | | metric_name | 是 | String | **参数解释**： 资源的监控指标名称，各服务资源的指标名称，请参阅具体云服务的文档。您可以直接从[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)页面导航至相应文档。 **约束限制**： 不涉及。 **取值范围**： 必须以字母开头，只能包含0-9/a-z/A-Z/_/-。字符长度最短为1，最大为96。如：弹性云服务器中的监控指标cpu_util，表示弹性服务器的CPU使用率；文档数据库中的指标mongo001_command_ps，表示command执行频率。 **默认取值**： 不涉及。 | | extra_info | 否 | [MetricExtraInfo] object | **参数解释**： 告警策略附加信息。 **约束限制**： 不涉及。 | | period | 是 | Integer | **参数解释**： 告警条件判断周期,单位为秒。 **约束限制**： 不涉及。 **取值范围**： 枚举值。 - 0是默认值，事件类告警该字段用0即可。 - 1代表指标的原始周期，比如RDS监控指标原始周期是60s，表示该RDS指标按60s周期为一个数据点参与告警计算。 - 300代表指标按5分钟聚合周期为一个数据点参与告警计算。 - 1200代表指标按20分钟聚合周期为一个数据点参与告警计算。 - 3600代表指标按1小时聚合周期为一个数据点参与告警计算。 - 14400代表指标按4小时聚合周期为一个数据点参与告警计算。 - 86400代表指标按1天聚合周期为一个数据点参与告警计算。 **默认取值**： 不涉及。 | | filter | 是 | String | **参数解释**： 聚合方式。 **约束限制**： period为1（原始值）时filter字段不生效，默认为average。period大于1时filter才起作用。 **取值范围**： - 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为准。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | hierarchical_value | 否 | [HierarchicalValue] object | **参数解释**： 多层级告警阈值。 **约束限制**： 当hierarchical_value和value同时使用时以hierarchical_value为准。 创建或修改告警规则以下2种场景只支持设置一个阈值： 1.告警类型为*指标告警* 且告警策略为*所有策略都满足才告警*的场景。 2.告警类型为*事件告警*的场景。 | | unit | 否 | String | **参数解释**： 数据的单位字符串，长度不超过32。 **约束限制**： 不涉及。 **取值范围**： 长度为\[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。 **默认取值**： 不涉及。 | | type | 否 | String | **参数解释**： 告警策略类型，已废弃，不推荐使用。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | alarm_level | 否 | Integer | **参数解释**： 告警级别。 **约束限制**： 不涉及。 **取值范围**： 只能为1、2、3、4。 - 1为紧急 - 2为重要 - 3为次要 - 4为提示 **默认取值**： 不涉及。 | | 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代表满足告警触发条件后每一天告警一次。 **默认取值**： 不涉及。 | 表5MetricExtraInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | origin_metric_name | 是 | String | **参数解释**： 原始指标名称。 **约束限制**： 不涉及。 **取值范围**： 长度为\[0,4096\]个字符。 **默认取值**： 不涉及。 | | metric_prefix | 否 | String | **参数解释**： 指标名称前缀。 **约束限制**： 不涉及。 **取值范围**： 长度为\[0,4096\]个字符。 **默认取值**： 不涉及。 | | custom_proc_name | 否 | String | **参数解释**： 用户进程名称。 **约束限制**： 不涉及。 **取值范围**： 长度为\[0,250\]个字符。 **默认取值**： 不涉及。 | | metric_type | 否 | String | **参数解释**： 指标类型。 **约束限制**： 不涉及。 **取值范围**： 长度为\[0,32\]个字符。 **默认取值**： 不涉及。 | 表6HierarchicalValue | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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\] **默认取值**： 不涉及。 | #### 响应参数 **状态码：201** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | template_id | String | **参数解释**： 告警模板的ID。 **取值范围**： 以at开头，后跟字母、数字，长度为\[2,64\]个字符。 | | overwrite_result | [OverwriteResultResp] object | **参数解释**： 如果出现同名模板，返回是否覆盖的结果信息。 | 表8OverwriteResultResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | success_ids | String | **参数解释**：已覆盖的模板ID值。 **取值范围**：长度为\[2,64\]个字符。 | | failed_ids | String | **参数解释**：未覆盖的模板ID值。 **取值范围**：长度为\[2,64\]个字符。 | **状态码：400** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 用于标识请求异常的具体原因。 **取值范围**： 字符串长度为0到256个字符。 | | error_msg | String | **参数解释**： 用于描述请求异常的具体信息。 **取值范围**： 字符串长度为0到256个字符。 | | request_id | String | **参数解释**： 用于唯一标识一次请求，便于问题追踪。 **取值范围**： 字符串长度为0到256个字符。 | **状态码：401** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 用于标识请求异常的具体原因。 **取值范围**： 字符串长度为0到256个字符。 | | error_msg | String | **参数解释**： 用于描述请求异常的具体信息。 **取值范围**： 字符串长度为0到256个字符。 | | request_id | String | **参数解释**： 用于唯一标识一次请求，便于问题追踪。 **取值范围**： 字符串长度为0到256个字符。 | **状态码：403** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 用于标识请求异常的具体原因。 **取值范围**： 字符串长度为0到256个字符。 | | error_msg | String | **参数解释**： 用于描述请求异常的具体信息。 **取值范围**： 字符串长度为0到256个字符。 | | request_id | String | **参数解释**： 用于唯一标识一次请求，便于问题追踪。 **取值范围**： 字符串长度为0到256个字符。 | **状态码：500** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 用于标识请求异常的具体原因。 **取值范围**： 字符串长度为0到256个字符。 | | error_msg | String | **参数解释**： 用于描述请求异常的具体信息。 **取值范围**： 字符串长度为0到256个字符。 | | request_id | String | **参数解释**： 用于唯一标识一次请求，便于问题追踪。 **取值范围**： 字符串长度为0到256个字符。 | #### 请求示例 创建告警模板名称为my_template，告警连续触发次数2次，每5分钟告警一次，告警级别重要的自定义模板。 ``` { "template_name" : "my_template", "template_description" : "hello world", "policies" : [ { "namespace" : "SYS.ECS", "dimension_name" : "instance_id", "metric_name" : "cpu_util", "period" : 300, "filter" : "sum", "comparison_operator" : ">", "value" : 2, "unit" : "bit/s", "count" : 2, "alarm_level" : 2, "suppress_duration" : 300 } ] } ``` #### 响应示例 **状态码：201** Created ``` { "template_id" : "at1628592157541dB1klWgY6" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 201 | Created | | 400 | 参数校验失败 | | 401 | 未认证 | | 403 | 认证鉴权失败 | | 500 | 系统内部错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-ces/ErrorCode.html)。