調用ALIYUN::CMS::MetricRuleTemplate建立警示模板 -

ALIYUN::CMS::MetricRuleTemplate類型用於建立警示模板。

文法

{
  "Type": "ALIYUN::CMS::MetricRuleTemplate",
  "Properties": {
    "AlertTemplates": List,
    "Description": String,
    "RestVersion": Integer,
    "TemplateId": Integer,
    "Name": String
  }
}

屬性

屬性名稱	類型	必須	允許更新	描述	約束
Name	String	是	否	警示模板名稱。	無
AlertTemplates	List	否	是	警示模板。	最多添加200個規則。更多資訊，請參見AlertTemplates屬性。
Description	String	否	是	警示模板描述資訊。	無
RestVersion	Integer	否	否	警示模板版本。	預設值為0。
TemplateId	Integer	否	否	複製模板ID。	無

AlertTemplates文法

"AlertTemplates": [
  {
    "MetricName": String,
    "Category": String,
    "Escalations": Map,
    "Period": Integer,
    "Webhook": String,
    "Namespace": String,
    "RuleName": String,
    "Selector": String
  }
]

AlertTemplates屬性

屬性名稱	類型	必須	允許更新	描述	約束
Category	String	是	是	產品名稱或產品規格縮寫。	取值： ecs：雲端服務器。 rds：阿里雲關係型資料庫。 ads：雲原生資料倉儲AnalyticDB MySQL版。 slb：負載平衡。 vpc：專用網路。 apigateway：API Gateway。 cdn：內容分發網路。 cs：Container ServiceKubernetes版。 dcdn：全站加速。 ddos：DDoS高防。 eip：Elastic IP Address。 elasticsearch：Elasticsearch。 emr：阿里雲E-MapReduce。 ess：Auto Scaling。 hbase：ApsaraDB for HBase版。 iot_edge：物聯網邊緣計算。 k8s_pod：k8s pod。 kvstore_sharding：Redis叢集版。 kvstore_splitrw：Redis讀寫分離版。 kvstore_standard：Redis標準版。 memcache：ApsaraDB for Memcache。 smq：Simple Message Queue (formerly MNS)。 mongodb：ApsaraDB for MongoDB複本集執行個體。 mongodb_cluster：ApsaraDB for MongoDB單節點執行個體。 mongodb_sharding：ApsaraDB for MongoDB分區叢集執行個體。 mq_topic：Simple Message Queue (formerly MNS)TOPIC。 ocs：ApsaraDB for Memcache。 opensearch：OpenSearch。 oss：Object Storage Service服務。 polardb：雲資料庫PolarDB。 petadata：HybridDB for MySQL。 scdn：安全加速。 sharebandwidthpackages：共用頻寬包。 sls：Log Service。 vpn：VPN網關。
MetricName	String	是	是	監控項名稱。	無
Namespace	String	是	是	產品的資料命名空間。	更多資訊，請參見DescribeMetricMetaList或監控指標使用說明。
RuleName	String	是	是	警示規則的名稱。	無
Escalations	Map	否	否	警示配置。	更多資訊，請參見Escalations屬性。
Period	Integer	否	是	監控資料的彙總周期。	預設為監控項對應的最小頻率，通常不需要指定。單位：秒。
Selector	String	否	是	擴充欄位選項。	無
Webhook	String	否	否	警示發生時的回調URL地址。	無

Escalations文法

"Escalations": {
  "Critical": Map,
  "Info": Map,
  "Warn": Map
}

Escalations屬性

屬性名稱	類型	必須	允許更新	描述	約束
Critical	Map	是	是	Critical層級警示設定。	更多資訊，請參見Critical屬性。
Info	Map	否	是	Info層級警示設定。	更多資訊，請參見Info屬性。
Warn	Map	否	是	Warn層級警示設定。	更多資訊，請參見Warn屬性。

Critical文法

"Critical": {
  "ComparisonOperator": String,
  "Times": Integer,
  "Statistics": String,
  "Threshold": String
}

Critical屬性

屬性名稱	類型	必須	允許更新	描述	約束
ComparisonOperator	String	是	是	閾值比較符。	取值： GreaterThanOrEqualToThreshold：大於等於。 GreaterThanThreshold：大於。 LessThanOrEqualToThreshold：小於等於。 LessThanThreshold：小於。 NotEqualToThreshold：不等。 GreaterThanYesterday：同比昨天時間上漲。 LessThanYesterday：同比昨天時間下降。 GreaterThanLastWeek：同比上周同一時間上漲。 LessThanLastWeek：同比上周同一時間下降。 GreaterThanLastPeriod：環比上周期上漲。 LessThanLastPeriod：環比上周期下降。
Statistics	String	是	是	警示統計方法。	無
Threshold	String	是	是	警示閾值。	無
Times	Integer	是	是	警示重試次數。	無

Info文法

"Info": {
  "ComparisonOperator": String,
  "Times": Integer,
  "Statistics": String,
  "Threshold": String
}

Info屬性

屬性名稱	類型	必須	允許更新	描述	約束
ComparisonOperator	String	是	是	閾值比較符。	取值： GreaterThanOrEqualToThreshold：大於等於。 GreaterThanThreshold：大於。 LessThanOrEqualToThreshold：小於等於 LessThanThreshold：小於。 NotEqualToThreshold：不等。 GreaterThanYesterday：同比昨天時間上漲。 LessThanYesterday：同比昨天時間下降。 GreaterThanLastWeek：同比上周同一時間上漲。 LessThanLastWeek：同比上周同一時間下降。 GreaterThanLastPeriod：環比上周期上漲。 LessThanLastPeriod：環比上周期下降。
Statistics	String	是	是	警示統計方法。	無
Threshold	String	是	是	警示閾值。	無
Times	Integer	是	是	警示重試次數。	無

Warn文法

"Warn": {
  "ComparisonOperator": String,
  "Times": Integer,
  "Statistics": String,
  "Threshold": String
}

Warn屬性

屬性名稱	類型	必須	允許更新	描述	約束
ComparisonOperator	String	是	是	閾值比較符。	取值： GreaterThanOrEqualToThreshold：大於等於。 GreaterThanThreshold：大於。 LessThanOrEqualToThreshold：小於等於。 LessThanThreshold：小於。 NotEqualToThreshold：不相等。 GreaterThanYesterday：同比昨天時間上漲。 LessThanYesterday：同比昨天時間下降。 GreaterThanLastWeek：同比上周同一時間上漲。 LessThanLastWeek：同比上周同一時間下降。 GreaterThanLastPeriod：環比上周期上漲。 LessThanLastPeriod：環比上周期下降。
Statistics	String	是	是	警示統計方法。	無
Threshold	String	是	是	警示閾值。	無
Times	Integer	是	是	警示重試次數。	無

傳回值

Fn::GetAtt

Id：警示模板ID。

樣本

`YAML`

ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  MetricRuleTemplate:
    Type: ALIYUN::CMS::MetricRuleTemplate
    Properties:
      AlertTemplates:
        - Category: ecs
          Namespace: acs_ecs_dashboard
          Period: 60
          Webhook: http://ww.aliyun.com
          RuleName: CPU監控
          Selector: ''
          MetricName: cpu_total
          Escalations:
            Critical:
              Statistics: Average
              Threshold: '90'
              ComparisonOperator: GreaterThanOrEqualToThreshold
              Times: 3
            Warn:
              Statistics: Average
              Threshold: '80'
              ComparisonOperator: GreaterThanOrEqualToThreshold
              Times: 3
            Info:
              Statistics: Average
              Threshold: '70'
              ComparisonOperator: GreaterThanOrEqualToThreshold
              Times: 3
        - Category: ecs
          Namespace: acs_ecs_dashboard
          Period: 60
          RuleName: 磁碟監控
          Selector: '{"disk":"/"}'
          MetricName: diskusage_total
          Escalations:
            Critical:
              Statistics: Average
              Threshold: '500'
              ComparisonOperator: GreaterThanOrEqualToThreshold
              Times: 5
      Name: TestMetricRuleTemplate
Outputs:
  Id:
    Description: Alarm template ID.
    Value:
      Fn::GetAtt:
        - MetricRuleTemplate
        - Id

`JSON`

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "MetricRuleTemplate": {
      "Type": "ALIYUN::CMS::MetricRuleTemplate",
      "Properties": {
        "AlertTemplates": [
          {
            "Category": "ecs",
            "Namespace": "acs_ecs_dashboard",
            "Period": 60,
            "Webhook": "http://ww.aliyun.com",
            "RuleName": "CPU監控",
            "Selector": "",
            "MetricName": "cpu_total",
            "Escalations": {
              "Critical": {
                "Statistics": "Average",
                "Threshold": "90",
                "ComparisonOperator": "GreaterThanOrEqualToThreshold",
                "Times": 3
              },
              "Warn": {
                "Statistics": "Average",
                "Threshold": "80",
                "ComparisonOperator": "GreaterThanOrEqualToThreshold",
                "Times": 3
              },
              "Info": {
                "Statistics": "Average",
                "Threshold": "70",
                "ComparisonOperator": "GreaterThanOrEqualToThreshold",
                "Times": 3
              }
            }
          },
          {
            "Category": "ecs",
            "Namespace": "acs_ecs_dashboard",
            "Period": 60,
            "RuleName": "磁碟監控",
            "Selector": "{\"disk\":\"/\"}",
            "MetricName": "diskusage_total",
            "Escalations": {
              "Critical": {
                "Statistics": "Average",
                "Threshold": "500",
                "ComparisonOperator": "GreaterThanOrEqualToThreshold",
                "Times": 5
              }
            }
          }
        ],
        "Name": "TestMetricRuleTemplate"
      }
    }
  },
  "Outputs": {
    "Id": {
      "Description": "Alarm template ID.",
      "Value": {
        "Fn::GetAtt": [
          "MetricRuleTemplate",
          "Id"
        ]
      }
    }
  }
}