文档首页/ 云监控服务 CES/ API参考/ API V2/ 告警模板/ 创建自定义告警模板
更新时间：2024-01-15 GMT+08:00
查看PDF
分享

创建自定义告警模板

功能介绍

创建自定义告警模板

调用方法

请参见如何调用API。

URI

POST /v2/{project_id}/alarm-templates

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户ID

最小长度：1

最大长度：64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

租户Token

最小长度：1

最大长度：16384
表3 请求Body参数

参数

是否必选

参数类型

描述

template_name

是

String

告警模板的名称，以字母或汉字开头，可包含字母、数字、汉字、_、-，长度范围[1,128]

template_type

否

Integer

自定义告警模板类型 0：指标 2： 事件

枚举值：

  • 0

  • 2

template_description

否

String

告警模板的描述，长度范围[0,256]，该字段默认值为空字符串

policies

是

Array of Policies objects

告警模板策略列表

数组长度：1 - 50
表4 Policies

参数

是否必选

参数类型

描述

namespace

是

String

查询服务的命名空间，各服务命名空间请参考“服务命名空间”

dimension_name

否

String

资源维度，必须以字母开头，多维度用","分割，只能包含0-9/a-z/A-Z/_/-，每个维度的最大长度为32, 事件告警模板DimensionName为空

metric_name

是

String

指标名称

period

是

Integer

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

枚举值：

  • 0

  • 1

  • 300

  • 1200

  • 3600

  • 14400

  • 86400

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

告警阈值(Number.MAX_VALUE)

最小值：0

最大值：1.7976931348623156E108

unit

否

String

数据的单位字符串，长度不超过32

最小长度：0

最大长度：32

count

是

Integer

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

alarm_level

否

Integer

告警级别，1为紧急，2为重要，3为次要，4为提示

suppress_duration

是

Integer

告警抑制周期，单位为秒，当告警抑制周期为0时，仅发送一次告警

枚举值：

  • 0

  • 300

  • 600

  • 900

  • 1800

  • 3600

  • 10800

  • 21600

  • 43200

  • 86400

响应参数

状态码： 201

表5 响应Body参数

参数

参数类型

描述

template_id

String

告警模板的ID，以at开头，后跟字母、数字，长度最长为64

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度：0

最大长度：256

error_msg

String

请求异常信息

最小长度：0

最大长度：256

request_id

String

请求ID

最小长度：0

最大长度：256

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度：0

最大长度：256

error_msg

String

请求异常信息

最小长度：0

最大长度：256

request_id

String

请求ID

最小长度：0

最大长度：256

状态码： 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度：0

最大长度：256

error_msg

String

请求异常信息

最小长度：0

最大长度：256

request_id

String

请求ID

最小长度：0

最大长度：256

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度：0

最大长度：256

error_msg

String

请求异常信息

最小长度：0

最大长度：256

request_id

String

请求ID

最小长度：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

系统内部错误

错误码

请参见错误码。

父主题： 告警模板