全部產品
Search
文件中心

Resource Orchestration Service:ALIYUN::ESS::AlarmTask

更新時間:Apr 10, 2025

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"
            ]
          }
        }
      }
    }