查询自定义告警模板列表

功能介绍

查询自定义告警模板列表。

调用方法

请参见如何调用API。

URI

GET /V1.0/{project_id}/alarm-template

• 参数说明

  表1 参数说明

  名称	参数类型	是否必选	说明
  project_id	String	是	项目ID。 获取方式请参见获取项目ID。
  alarmTemplateId	String	否	自定义告警模的ID，如：at1603330892378wkDm77y6B。
  namespace	String	否	资源命名空间，如弹性云服务器的资源命名空间为：SYS.ECS，各服务命名空间可查看支持监控的服务列表。
  dname	String	否	自定义告警模板选择的资源维度，例如弹性云服务器维度为instance_id。各服务的监控维度可查看支持监控的服务列表。
  start	String	否	分页起始值，类型为integer，默认值为0。
  limit	String	否	单次查询的条数限制，取值范围(0,100]，默认值为100，用于限制结果数据条数。

• 样例

  GET https://{云监控的endpoint}/V1.0/{project_id}/alarms/alarm-template

请求消息

无

响应消息

• 响应参数

  名称	参数类型	是否必选	说明
  alarm_templates	Array of objects	否	自定义告警模板详细信息。 详细参数说明请参见表2。
  meta_data	MetaData object	否	查询结果元数据信息，包括分页信息等。 详细参数说明请参见表5。

  表2 alarm_templates字段数据结构说明

  名称	参数类型	是否必选	说明
  template_name	String	否	自定义告警模板名称，如:alarmTemplate-Test01。
  template_description	String	否	自定义告警模板描述。
  namespace	String	否	资源命名空间，如弹性云服务器的资源命名空间为：SYS.ECS，各服务命名空间可查看支持监控的服务列表。
  dimension_name	String	否	自定义告警模板选择的资源维度，例如弹性云服务器维度为instance_id。各服务的监控维度可查看支持监控的服务列表。
  template_items	Array of objects	否	自定义告警模板添加的一组或者多个告警策略。 详细参数说明请参见表3。
  template_id	String	否	自定义告警模板的ID，如：at1603330892378wkDm77y6B。

  表3 template_items字段数据结构说明

  名称	参数类型	是否必选	说明
  metric_name	String	是	告警模板添加的监控指标，如弹性云服务器可添加的监控指标为cpu_util等，各资源的监控指标名称可查看支持监控的服务列表。
  condition	Condition object	是	创建自定义告警模板的告警策略。 详细参数说明请参见表4。
  alarm_level	Integer	否	设置告警级别。值为1、2、3、4。其中1为紧急，2为重要，3为次要，4为提示。

  表4 condition字段数据结构说明

  名称	参数类型	是否必选	说明
  period	Integer	是	监控数据粒度。 取值范围： 1，实时数据 300，5分钟粒度 1200，20分钟粒度 3600，1小时粒度 14400，4小时粒度 86400，1天粒度
  filter	String	是	数据聚合方式，支持的聚合方式如下: average：聚合周期内指标数据的平均值。 max：聚合周期内指标数据的最大值。 min：聚合周期内指标数据的最小值。 sum：聚合周期内指标数据的求和值。 variance：聚合周期内指标数据的方差。
  comparison_operator	String	是	告警阈值的比较条件，可以是>、=、<、>=、<=。
  value	Double	是	告警阈值。取值范围[0, Number.MAX_VALUE]，Number.MAX_VALUE值为1.7976931348623157e+108。具体阈值取值请参见附录中各服务监控指标中取值范围，如支持监控的服务列表中ECS的CPU使用率cpu_util取值范围可配置80。
  unit	String	否	数据的单位，最大长度为32位。
  count	Integer	是	触发告警的连续发生次数，取值范围[1, 5]。
  suppress_duration	Integer	否	发送告警的周期。值可为0、300、600、900、1800、3600、10800、21600、43200、86400。0表示只告警一次，300表示每5分钟告警一次，600表示每10分钟告警一次，900表示每15分钟告警一次，1800表示每30分钟告警一次，3600表示每1小时告警一次，10800表示每3小时告警一次，21600表示每6小时告警一次，43200表示每12小时告警一次，86400表示每1天告警一次。

  表5 meta_data字段数据结构说明

  名称	参数类型	是否必选	说明
  total	Integer	是	结果总条数。
  count	Integer	是	当前返回结果条数。
  marker	String	是	下一个开始的标记，用于分页。

  • 返回样例

    {
     "alarm_templates": [
       {
         "template_name": "alarmTemplate-Test01",
         "template_description": "查询自定义告警模板",
         "namespace": "SYS.ECS",
         "dimension_name": "instance_id",
         "template_items": [
           {
             "metric_name": "cpu_util",
             "condition": {
               "period": 1,
               "filter": "average",
               "comparison_operator": ">=",
               "value": 90,
               "unit": "%",
               "count": 3,
               "suppress_duration": 300
             },
             "alarm_level": 2
           },
           {
             "metric_name": "mem_util",
             "condition": {
               "period": 1,
               "filter": "average",
               "comparison_operator": ">=",
               "value": 90,
               "unit": "%",
               "count": 3,
               "suppress_duration": 600
             },
             "alarm_level": 2
           }
         ],
         "template_id": "at1604474818207Jo7o7R4Nj"
       }
     ],
     "meta_data": {
       "count": 1,
       "marker": "",
       "total": 1
     }
    }

返回值

• 正常

  200

• 异常

  返回值	说明
  400 Bad Request	请求错误。
  401 Unauthorized	未提供认证信息，或认证信息错误。
  403 Forbidden	请求页面被禁止访问。
  408 Request Timeout	请求超出了服务器的等待时间。
  429 Too Many Requests	当前请求过多。
  500 Internal Server Error	请求未完成，服务异常。
  503 Service Unavailable	系统暂时不可用，请求受限。

错误码

请参考返回错误码说明。