Resource Orchestration Service:ALIYUN::CMS::GroupMetricRule

Syntax

{
  "Type": "ALIYUN::CMS::GroupMetricRule",
  "Properties": {
    "NoEffectiveInterval": String,
    "SilenceTime": Integer,
    "Category": String,
    "RuleId": String,
    "Dimensions": String,
    "Period": Integer,
    "EffectiveInterval": String,
    "Namespace": String,
    "GroupId": String,
    "MetricName": String,
    "Escalations": Map,
    "EmailSubject": String,
    "Webhook": String,
    "RuleName": String,
    "Interval": Integer
  }
}

Properties

Escalations syntax

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

Escalations properties

Critical syntax

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

Critical properties

Info syntax

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

Info properties

Warn syntax

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

Warn properties

Response parameters

Fn::GetAtt

RuleId: the ID of the alert rule.

Examples

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "NoEffectiveInterval": {
      "Type": "String",
      "Description": "The period when the alert rule is ineffective."
    },
    "SilenceTime": {
      "Type": "Number",
      "Description": "The duration of the mute period during which new alerts are not sent even if the trigger\nconditions are met. Unit: second. Default value: 86400. Minimum value: 60.",
      "MinValue": 60
    },
    "Category": {
      "Type": "String",
      "Description": "The abbreviation of the service name. Valid values:\nECS (including Alibaba Cloud and non-Alibaba Cloud hosts)\nRDS (ApsaraDB for RDS)\nADS (AnalyticDB)\nSLB (Server Load Balancer)\nVPC (Virtual Private Cloud)\nAPIGATEWAY (API Gateway)\nCDN\nCS (Container Service for Swarm)\nDCDN (Dynamic Route for CDN)\nDDoS (distributed denial of service)\nEIP (Elastic IP)\nELASTICSEARCH (Elasticsearch)\nEMR (E-MapReduce)\nESS (Auto Scaling)\nHBASE (ApsaraDB for HBase)\nIOT_EDGE (IoT Edge)\nK8S_POD (k8s pod)\nKVSTORE_SHARDING (ApsaraDB for Redis cluster version)\nKVSTORE_SPLITRW (ApsaraDB for Redis read/write splitting version)\nKVSTORE_STANDARD (ApsaraDB for Redis standard version)\nMEMCACHE (ApsaraDB for Memcache)\nMNS (Message Service)\nMONGODB (ApsaraDB for MongoDB replica set instances)\nMONGODB_CLUSTER (ApsaraDB for MongoDB cluster version)\nMONGODB_SHARDING (ApsaraDB for MongoDB sharded clusters)\nMQ_TOPIC (Message Service topic)\nOCS (original version of ApsaraDB for Memcache)\nOPENSEARCH (Open Search)\nOSS (Object Storage Service)\nPOLARDB (ApsaraDB for POLARDB)\nPETADATA (HybridDB for MySQL)\nSCDN (Secure Content Delivery Network)\nSHAREBANDWIDTHPACKAGES (shared bandwidth package)\nSLS (Log Service)\nVPN (VPN Gateway)"
    },
    "RuleId": {
      "Type": "String",
      "Description": "The ID of the alert rule. The IDs of alert rules are generated by callers to ensure\nuniqueness."
    },
    "Dimensions": {
      "Type": "String",
      "Description": "The expended resource dimensions."
    },
    "Period": {
      "Type": "Number",
      "Description": "The aggregation period. Unite: second."
    },
    "EffectiveInterval": {
      "Type": "String",
      "Description": "The period when the alert rule is effective."
    },
    "Namespace": {
      "Type": "String",
      "Description": "The data namespace of the service. For more information, call DescribeMetricMetaList\nor see Preset metrics reference."
    },
    "GroupId": {
      "Type": "String",
      "Description": "The ID of application group."
    },
    "MetricName": {
      "Type": "String",
      "Description": "The name of the metric. For more information, call DescribeMetricMetaList or see Preset metrics reference."
    },
    "Escalations": {
      "Type": "Json"
    },
    "EmailSubject": {
      "Type": "String",
      "Description": "The subject of the alert notification email."
    },
    "Webhook": {
      "Type": "String",
      "Description": "The URL of the callback triggered when an alert occurs."
    },
    "RuleName": {
      "Type": "String",
      "Description": "The name of the alert rule."
    },
    "Interval": {
      "Type": "Number",
      "Description": "The detection period of alerts."
    }
  },
  "Resources": {
    "GroupMetricRule": {
      "Type": "ALIYUN::CMS::GroupMetricRule",
      "Properties": {
        "NoEffectiveInterval": {
          "Ref": "NoEffectiveInterval"
        },
        "SilenceTime": {
          "Ref": "SilenceTime"
        },
        "Category": {
          "Ref": "Category"
        },
        "RuleId": {
          "Ref": "RuleId"
        },
        "Dimensions": {
          "Ref": "Dimensions"
        },
        "Period": {
          "Ref": "Period"
        },
        "EffectiveInterval": {
          "Ref": "EffectiveInterval"
        },
        "Namespace": {
          "Ref": "Namespace"
        },
        "GroupId": {
          "Ref": "GroupId"
        },
        "MetricName": {
          "Ref": "MetricName"
        },
        "Escalations": {
          "Ref": "Escalations"
        },
        "EmailSubject": {
          "Ref": "EmailSubject"
        },
        "Webhook": {
          "Ref": "Webhook"
        },
        "RuleName": {
          "Ref": "RuleName"
        },
        "Interval": {
          "Ref": "Interval"
        }
      }
    }
  },
  "Outputs": {
    "RuleId": {
      "Description": "Rule ID.",
      "Value": {
        "Fn::GetAtt": [
          "GroupMetricRule",
          "RuleId"
        ]
      }
    }
  }
}

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  NoEffectiveInterval:
    Type: String
    Description: The period when the alert rule is ineffective.
  SilenceTime:
    Type: Number
    Description: >-
      The duration of the mute period during which new alerts are not sent even
      if the trigger
      conditions are met. Unit: second. Default value: 86400. Minimum value: 60.
    MinValue: 60
  Category:
    Type: String
    Description: |-
      The abbreviation of the service name. Valid values:
      ECS (including Alibaba Cloud and non-Alibaba Cloud hosts)
      RDS (ApsaraDB for RDS)
      ADS (AnalyticDB)
      SLB (Server Load Balancer)
      VPC (Virtual Private Cloud)
      APIGATEWAY (API Gateway)
      CDN
      CS (Container Service for Swarm)
      DCDN (Dynamic Route for CDN)
      DDoS (distributed denial of service)
      EIP (Elastic IP)
      ELASTICSEARCH (Elasticsearch)
      EMR (E-MapReduce)
      ESS (Auto Scaling)
      HBASE (ApsaraDB for HBase)
      IOT_EDGE (IoT Edge)
      K8S_POD (k8s pod)
      KVSTORE_SHARDING (ApsaraDB for Redis cluster version)
      KVSTORE_SPLITRW (ApsaraDB for Redis read/write splitting version)
      KVSTORE_STANDARD (ApsaraDB for Redis standard version)
      MEMCACHE (ApsaraDB for Memcache)
      MNS (Message Service)
      MONGODB (ApsaraDB for MongoDB replica set instances)
      MONGODB_CLUSTER (ApsaraDB for MongoDB cluster version)
      MONGODB_SHARDING (ApsaraDB for MongoDB sharded clusters)
      MQ_TOPIC (Message Service topic)
      OCS (original version of ApsaraDB for Memcache)
      OPENSEARCH (Open Search)
      OSS (Object Storage Service)
      POLARDB (ApsaraDB for POLARDB)
      PETADATA (HybridDB for MySQL)
      SCDN (Secure Content Delivery Network)
      SHAREBANDWIDTHPACKAGES (shared bandwidth package)
      SLS (Log Service)
      VPN (VPN Gateway)
  RuleId:
    Type: String
    Description: >-
      The ID of the alert rule. The IDs of alert rules are generated by callers
      to ensure

      uniqueness.
  Dimensions:
    Type: String
    Description: The expended resource dimensions.
  Period:
    Type: Number
    Description: 'The aggregation period. Unite: second.'
  EffectiveInterval:
    Type: String
    Description: The period when the alert rule is effective.
  Namespace:
    Type: String
    Description: >-
      The data namespace of the service. For more information, call
      DescribeMetricMetaList
      or see Preset metrics reference.
  GroupId:
    Type: String
    Description: The ID of application group.
  MetricName:
    Type: String
    Description: >-
      The name of the metric. For more information, call DescribeMetricMetaList
      or see Preset metrics reference.
  Escalations:
    Type: Json
  EmailSubject:
    Type: String
    Description: The subject of the alert notification email.
  Webhook:
    Type: String
    Description: The URL of the callback triggered when an alert occurs.
  RuleName:
    Type: String
    Description: The name of the alert rule.
  Interval:
    Type: Number
    Description: The detection period of alerts.
Resources:
  GroupMetricRule:
    Type: 'ALIYUN::CMS::GroupMetricRule'
    Properties:
      NoEffectiveInterval:
        Ref: NoEffectiveInterval
      SilenceTime:
        Ref: SilenceTime
      Category:
        Ref: Category
      RuleId:
        Ref: RuleId
      Dimensions:
        Ref: Dimensions
      Period:
        Ref: Period
      EffectiveInterval:
        Ref: EffectiveInterval
      Namespace:
        Ref: Namespace
      GroupId:
        Ref: GroupId
      MetricName:
        Ref: MetricName
      Escalations:
        Ref: Escalations
      EmailSubject:
        Ref: EmailSubject
      Webhook:
        Ref: Webhook
      RuleName:
        Ref: RuleName
      Interval:
        Ref: Interval
Outputs:
  RuleId:
    Description: Rule ID.
    Value:
      'Fn::GetAtt':
        - GroupMetricRule
        - RuleId