ALIYUN::ESS::AlarmTask类型用于创建监控项报警任务。

语法

{
  "Type": "ALIYUN::ESS::AlarmTask",
  "Properties": {
    "Statistics": String,
    "Name": String,
    "EvaluationCount": Integer,
    "Period": Integer,
    "MetricType": String,
    "ComparisonOperator": String,
    "Dimensions": List,
    "ScalingGroupId": String,
    "AlarmAction": List,
    "Threshold": Number,
    "MetricName": String,
    "GroupId": Integer,
    "Description": String
  }
}

属性

属性名称类型必须允许更新描述约束
StatisticsString统计方法,必须与定义的metric一致,例如Average。可选值:Average、Minimum、Maximum。
NameString报警规则名称。
EvaluationCountInteger连续探测几次都满足阈值条件时报警,默认3次。最小为1。
PeriodInteger查询指标的周期,必须与定义的metric一致,默认300,单位为秒可用值:60、120、300、900。
MetricTypeString标准类型。可用值:system、custom。
ComparisonOperatorString报警比较符。只能为以下几种<=、<、>、>=。
DimensionsList报警规则对应实例列表。最少一个。
ScalingGroupIdString伸缩组ID。
AlarmActionList报警动作列表。最少1个,最多5个。
ThresholdNumber报警阈值,目前只开放数值类型功能。
MetricNameString相应产品对应的监控项名称,参考各产品metric定义。
GroupIdInteger组ID。
DescriptionString描述。

Dimensions语法

"Dimensions": [
  {
    "DimensionKey": String,
    "DimensionValue": String 
  }
]

Dimensions属性

属性名称类型必须允许更新描述约束
DimensionValueString监控项关联的维度信息值。
DimensionKeyString监控项关联的维度信息键。

返回值

Fn::GetAtt

AlarmTaskId:报警任务ID。

示例

  • YAML格式

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      AutoScalingGroupId:
        Type: String
        AssociationProperty: ALIYUN::ESS::AutoScalingGroup::AutoScalingGroupId
      AlarmAction:
        Type: CommaDelimitedList
        Description: Alarm Actions
        MinLength: 1
        MaxLength: 5
    Resources:
      AlarmTask:
        Type: ALIYUN::ESS::AlarmTask
        Properties:
          ScalingGroupId:
            Ref: AutoScalingGroupId
          AlarmAction:
            - ari:acs:ess:cn-hangzhou:140692647406****:scalingrule/asr-bp1dvirgwkoowxk7****
          Threshold: 1
          MetricName: TestMetric
          MetricType: custom
          Statistics: Average
    Outputs:
      AlarmTaskId:
        Description: The alarm task ID
        Value:
          Fn::GetAtt:
            - AlarmTask
            - AlarmTaskId
  • JSON格式

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "AutoScalingGroupId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ESS::AutoScalingGroup::AutoScalingGroupId"
        },
        "AlarmAction": {
          "Type": "CommaDelimitedList",
          "Description": "Alarm Actions",
          "MinLength": 1,
          "MaxLength": 5
        }
      },
      "Resources": {
        "AlarmTask": {
          "Type": "ALIYUN::ESS::AlarmTask",
          "Properties": {
            "ScalingGroupId": {
              "Ref": "AutoScalingGroupId"
            },
            "AlarmAction": [
              "ari:acs:ess:cn-hangzhou:140692647406****:scalingrule/asr-bp1dvirgwkoowxk7****"
            ],
            "Threshold": 1,
            "MetricName": "TestMetric",
            "MetricType": "custom",
            "Statistics": "Average"
          }
        }
      },
      "Outputs": {
        "AlarmTaskId": {
          "Description": "The alarm task ID",
          "Value": {
            "Fn::GetAtt": [
              "AlarmTask",
              "AlarmTaskId"
            ]
          }
        }
      }
    }