Creates an alert template.

This topic provides an example on how to create an alert template named Template_test and create an alert rule for the cpu_total metric of Elastic Compute Service (ECS) in the template. The name of the alert rule is Rule_test. The alert level is Critical. The statistical method is Average. The alert threshold comparator is GreaterThanOrEqualToThreshold. The alert threshold is 90. The number of alert retries is 3. The returned result indicates that the alert template is created and the alert template ID is 12345.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateMetricRuleTemplate

The operation that you want to perform. Set the value to CreateMetricRuleTemplate.

Name String Yes Template_test

The name of the alert template.

AlertTemplates.N.MetricName String Yes cpu_total

The name of the metric. Valid values of N: 1 to 200.

For information about how to obtain the name of a metric, see DescribeMetricMetaList or Appendix 1: Metrics.

AlertTemplates.N.RuleName String Yes Rule_test

The name of the alert rule. Valid values of N: 1 to 200.

AlertTemplates.N.Category String Yes ecs

The abbreviation of the service name. Valid values of N: 1 to 200. Valid values:

  • PolarDB: PolarDB
  • NewBGPDDoS: Anti-DDoS Pro
  • IoTDevice: IoT Platform
  • DRDS: PolarDB-X
  • VS: Video Surveillance System
  • AMQP: Alibaba Cloud Message Queue for AMQP
  • ADS: AnalyticDB
  • APIGateway: API Gateway
  • InternetSharedBandwidth: EIP Bandwidth Plan
  • CDN: Alibaba Cloud Content Delivery Network (CDN)
  • CEN: Cloud Enterprise Network (CEN)
  • DCDN: Dynamic Route for CDN (DCDN)
  • DDoS: Anti-DDoS
  • ECS: Elastic Compute Service (ECS)
  • DirectMail: Direct Mail
  • Elasticsearch: Elasticsearch
  • EMR: E-MapReduce (EMR)
  • ESS: Auto Scaling
  • FunctionCompute: Function Compute
  • RealtimeCompute: Realtime Compute for Apache Flink
  • GlobalAcceleration: Global Accelerator (GA)
  • Hbase: ApsaraDB for HBase
  • TSDB: Time Series Database (TSDB)
  • IPv6trans: IPv6 Translation Service
  • Kafka: Message Queue for Apache Kafka
  • Kubernetes: Container Service for Kubernetes (ACK)
  • KVstore: ApsaraDB for Redis
  • MNS: Message Service (MNS)
  • MongoDB: ApsaraDB for MongoDB
  • MQ: Message Queue
  • NAT: NAT Gateway
  • OpenAd: Open Ad
  • OpenSearch: Open Search
  • OSS: Object Storage Service (OSS)
  • PCDN: P2P CDN
  • petadata: HybridDB for MySQL
  • RDS: ApsaraDB RDS
  • SCDN: Secure CDN
  • SLB: Server Load Balancer (SLB)
  • SLS: Log Service
  • VideoLive: ApsaraVideo Live
  • VOD: ApsaraVideo VOD
  • EIP: Elastic IP Address (EIP)
  • VPN: VPN Gateway
  • AIRec: Artificial Intelligence Recommendation (AIRec)
  • GPDB: AnalyticDB for PostgreSQL
  • DBS: Database Backup (DBS)
  • SAG: Smart Access Gateway (SAG)
  • Memcache: ApsaraDB for Memcache
  • IOT_EDGE: Link IoT Edge
  • OCS: ApsaraDB for Memcache (previous version)
  • VPC: Express Connect
  • EHPC: Elastic High Performance Computing (E-HPC)
  • MPS: ApsaraVideo Media Processing (MPS)
  • ENS: Edge Node Service (ENS)
  • MaxCompute_Prepay: MaxCompute
  • IoT_Kubernetes: Edge Application Hosting
  • CMS: CloudMonitor
  • batchcomputenew: Batch Compute
  • HBaseUE: ApsaraDB for HBase Performance-enhanced Edition
  • UIS: Ultimate Internet Service (UIS)
  • nls: Intelligent Speech Interaction
  • ots: Tablestore
  • NAS: Apsara File Storage NAS
  • ECI: Elastic Container Instance (ECI)
  • OpenAPI: OpenAPI Explorer
  • pvtzpost: Alibaba Cloud DNS PrivateZone
  • blinkonk8s: Flink on Kubernetes
  • FunctionFlow: Serverless Workflow (SWF)
  • SMC: Server Migration Center (SMC)
  • ddosbgp: Anti-DDoS Origin
  • baas: Blockchain as a Service
  • privatelink: PrivateLink
  • cds: ApsaraDB for Cassandra
  • DDH: Dedicated Host
  • RocketMQ: Message Queue for Apache RocketMQ
  • ECC: Express Cloud Connect
  • hbaseserverless: ApsaraDB for HBase Serverless Edition
  • mns_tmp: Message Service
  • hdr: Hybrid Disaster Recovery (HDR)
  • hbr: Hybrid Backup Recovery (HBR)
  • ADB: AnalyticDB for MySQL V3.0
  • tag: Tag Service
  • GDB: Graph Database
  • WAF: Web Application Firewall (WAF)
  • hcs_sgw: Cloud Storage Gateway (CSG)
  • ipv6gateway: IPv6 Gateway
  • RDS_SAR: ApsaraDB Exclusive Host Group
  • learn: Machine Learning Platform for AI
  • ROS: Resource Orchestration Service (ROS)
  • OOS: Operation Orchestration Service (OOS)
  • bds: Data Synchronization for HBase
  • cfw: Cloud Firewall
  • ddosDip: Anti-DDoS Premium
  • datahub: DataHub
  • hologres: Hologres
  • ExpressConnect: Express Connect
  • dbfs: Database File System (DBFS)
  • clickhouse: ApsaraDB for ClickHouse
  • k8s: Container Service for Kubernetes (ACK)
  • DTS: Data Transmission Service (DTS)
  • AnycastEIP: Anycast Elastic IP Address
  • Lindorm: ApsaraDB for Lindorm
  • config: Cloud Config
  • spark: Databricks DataInsight (DDI)
  • serverless: Serverless App Engine (SAE)
  • alb: Application Load Balancer (ALB)
  • oceanbase: ApsaraDB for OceanBase
  • KMS: Key Management Service (KMS)
  • lvwang: Content Moderation
  • LinkVisual: LinkVisual
  • tair: ApsaraDB for Redis Enhanced Edition (Tair)
  • dlf: Data Lake Formation (DLF)
  • networkmonitor: Site Monitoring
  • pnc: Physical Network Change
  • AIS: Alibaba Cloud Infrastructure
  • cloudgame: Cloud Gaming Platform
  • RTC: Real-Time Communication
  • cloudbox: CloudBox
  • actiontrail: ActionTrail
  • cc: Cloud Connector
  • disk: Elastic Block Storage (EBS)
  • easygene: Genomics Computing Platform
  • cloudphone: Elastic Cloud Phone
  • BMS: Bare Metal Management Service
  • swas: Simple Application Server
  • AvailabilityMonitoring: Availability Monitoring of CloudMonitor
AlertTemplates.N.Namespace String Yes acs_ecs_dashboard

The namespace of the cloud service. Valid values of N: 1 to 200.

For information about how to obtain the namespace of a cloud service, see DescribeMetricMetaList or Appendix 1: Metrics.

Description String No ECS_Template1

The description of the alert template.

AlertTemplates.N.Period Integer No 60

The aggregation period of the metric data. Valid values of N: 1 to 200.

Set the Period parameter to an integral multiple of 60. Unit: seconds. The default value is the minimum aggregation period.

AlertTemplates.N.Selector String No {"disk":"/"}

The extended field selectors. Valid values of N: 1 to 200.

AlertTemplates.N.Escalations.Critical.Statistics String No Average

The statistical methods for Critical-level alerts. Separate multiple statistical methods with commas (,). Valid values of N: 1 to 200. Valid values:

  • Average: the average value
  • Minimum: the minimum value
  • Maximum: the maximum value
Note You must set a collection of the Rules.N.Escalations.Critical.Statistics, Rules.N.Escalations.Critical.ComparisonOperator, Rules.N.Escalations.Critical.Threshold, and Rules.N.Escalations.Critical.Times parameters, a collection of the Rules.N.Escalations.Warn.Statistics, Rules.N.Escalations.Warn.ComparisonOperator, Rules.N.Escalations.Warn.Threshold, and Rules.N.Escalations.Warn.Times parameters, or a collection of the Rules.N.Escalations.Info.Statistics, Rules.N.Escalations.Info.ComparisonOperator, Rules.N.Escalations.Info.Threshold, and Rules.N.Escalations.Info.Times parameters.
AlertTemplates.N.Escalations.Critical.ComparisonOperator String No GreaterThanOrEqualToThreshold

The comparison operator that is used to compare the metric value with the threshold. Valid values of N: 1 to 200. Valid values:

  • GreaterThanOrEqualToThreshold: greater than or equal to the threshold
  • GreaterThanThreshold: greater than the threshold
  • LessThanOrEqualToThreshold: less than or equal to the threshold
  • LessThanThreshold: less than the threshold
  • NotEqualToThreshold: not equal to the threshold
  • GreaterThanYesterday: greater than the metric value at the same time yesterday
  • LessThanYesterday: less than the metric value at the same time yesterday
  • GreaterThanLastWeek: greater than the metric value at the same time last week
  • LessThanLastWeek: less than the metric value at the same time last week
  • GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle
  • LessThanLastPeriod: less than the metric value in the last monitoring cycle
Note You must set a collection of the Rules.N.Escalations.Critical.Statistics, Rules.N.Escalations.Critical.ComparisonOperator, Rules.N.Escalations.Critical.Threshold, and Rules.N.Escalations.Critical.Times parameters, a collection of the Rules.N.Escalations.Warn.Statistics, Rules.N.Escalations.Warn.ComparisonOperator, Rules.N.Escalations.Warn.Threshold, and Rules.N.Escalations.Warn.Times parameters, or a collection of the Rules.N.Escalations.Info.Statistics, Rules.N.Escalations.Info.ComparisonOperator, Rules.N.Escalations.Info.Threshold, and Rules.N.Escalations.Info.Times parameters.
AlertTemplates.N.Escalations.Critical.Threshold String No 90

The threshold for Critical-level alerts. Valid values of N: 1 to 200.

Note You must set a collection of the Rules.N.Escalations.Critical.Statistics, Rules.N.Escalations.Critical.ComparisonOperator, Rules.N.Escalations.Critical.Threshold, and Rules.N.Escalations.Critical.Times parameters, a collection of the Rules.N.Escalations.Warn.Statistics, Rules.N.Escalations.Warn.ComparisonOperator, Rules.N.Escalations.Warn.Threshold, and Rules.N.Escalations.Warn.Times parameters, or a collection of the Rules.N.Escalations.Info.Statistics, Rules.N.Escalations.Info.ComparisonOperator, Rules.N.Escalations.Info.Threshold, and Rules.N.Escalations.Info.Times parameters.
AlertTemplates.N.Escalations.Critical.Times Integer No 3

The consecutive number of times for which the metric value meets the alert condition before a Critical-level alert is triggered. Valid values of N: 1 to 200.

Note You must set a collection of the Rules.N.Escalations.Critical.Statistics, Rules.N.Escalations.Critical.ComparisonOperator, Rules.N.Escalations.Critical.Threshold, and Rules.N.Escalations.Critical.Times parameters, a collection of the Rules.N.Escalations.Warn.Statistics, Rules.N.Escalations.Warn.ComparisonOperator, Rules.N.Escalations.Warn.Threshold, and Rules.N.Escalations.Warn.Times parameters, or a collection of the Rules.N.Escalations.Info.Statistics, Rules.N.Escalations.Info.ComparisonOperator, Rules.N.Escalations.Info.Threshold, and Rules.N.Escalations.Info.Times parameters.
AlertTemplates.N.Escalations.Warn.Statistics String No Average

The statistical methods for Warn-level alerts. Separate multiple statistical methods with commas (,). Valid values of N: 1 to 200. Valid values:

  • Average: the average value
  • Minimum: the minimum value
  • Maximum: the maximum value
Note You must set a collection of the Rules.N.Escalations.Critical.Statistics, Rules.N.Escalations.Critical.ComparisonOperator, Rules.N.Escalations.Critical.Threshold, and Rules.N.Escalations.Critical.Times parameters, a collection of the Rules.N.Escalations.Warn.Statistics, Rules.N.Escalations.Warn.ComparisonOperator, Rules.N.Escalations.Warn.Threshold, and Rules.N.Escalations.Warn.Times parameters, or a collection of the Rules.N.Escalations.Info.Statistics, Rules.N.Escalations.Info.ComparisonOperator, Rules.N.Escalations.Info.Threshold, and Rules.N.Escalations.Info.Times parameters.
AlertTemplates.N.Escalations.Warn.ComparisonOperator String No GreaterThanOrEqualToThreshold

The comparison operator that is used to compare the metric value with the threshold. Valid values of N: 1 to 200. Valid values:

  • GreaterThanOrEqualToThreshold: greater than or equal to the threshold
  • GreaterThanThreshold: greater than the threshold
  • LessThanOrEqualToThreshold: less than or equal to the threshold
  • LessThanThreshold: less than the threshold
  • NotEqualToThreshold: not equal to the threshold
  • GreaterThanYesterday: greater than the metric value at the same time yesterday
  • LessThanYesterday: less than the metric value at the same time yesterday
  • GreaterThanLastWeek: greater than the metric value at the same time last week
  • LessThanLastWeek: less than the metric value at the same time last week
  • GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle
  • LessThanLastPeriod: less than the metric value in the last monitoring cycle
Note You must set a collection of the Rules.N.Escalations.Critical.Statistics, Rules.N.Escalations.Critical.ComparisonOperator, Rules.N.Escalations.Critical.Threshold, and Rules.N.Escalations.Critical.Times parameters, a collection of the Rules.N.Escalations.Warn.Statistics, Rules.N.Escalations.Warn.ComparisonOperator, Rules.N.Escalations.Warn.Threshold, and Rules.N.Escalations.Warn.Times parameters, or a collection of the Rules.N.Escalations.Info.Statistics, Rules.N.Escalations.Info.ComparisonOperator, Rules.N.Escalations.Info.Threshold, and Rules.N.Escalations.Info.Times parameters.
AlertTemplates.N.Escalations.Warn.Threshold String No 90

The threshold for Warn-level alerts. Valid values of N: 1 to 200.

Note You must set a collection of the Rules.N.Escalations.Critical.Statistics, Rules.N.Escalations.Critical.ComparisonOperator, Rules.N.Escalations.Critical.Threshold, and Rules.N.Escalations.Critical.Times parameters, a collection of the Rules.N.Escalations.Warn.Statistics, Rules.N.Escalations.Warn.ComparisonOperator, Rules.N.Escalations.Warn.Threshold, and Rules.N.Escalations.Warn.Times parameters, or a collection of the Rules.N.Escalations.Info.Statistics, Rules.N.Escalations.Info.ComparisonOperator, Rules.N.Escalations.Info.Threshold, and Rules.N.Escalations.Info.Times parameters.
AlertTemplates.N.Escalations.Warn.Times Integer No 3

The consecutive number of times for which the metric value meets the alert condition before a Warn-level alert is triggered. Valid values of N: 1 to 200.

Note You must set a collection of the Rules.N.Escalations.Critical.Statistics, Rules.N.Escalations.Critical.ComparisonOperator, Rules.N.Escalations.Critical.Threshold, and Rules.N.Escalations.Critical.Times parameters, a collection of the Rules.N.Escalations.Warn.Statistics, Rules.N.Escalations.Warn.ComparisonOperator, Rules.N.Escalations.Warn.Threshold, and Rules.N.Escalations.Warn.Times parameters, or a collection of the Rules.N.Escalations.Info.Statistics, Rules.N.Escalations.Info.ComparisonOperator, Rules.N.Escalations.Info.Threshold, and Rules.N.Escalations.Info.Times parameters.
AlertTemplates.N.Escalations.Info.Statistics String No Average

The statistical methods for Info-level alerts. Separate multiple statistical methods with commas (,). Valid values of N: 1 to 200. Valid values:

  • Average: the average value
  • Minimum: the minimum value
  • Maximum: the maximum value
Note You must set a collection of the Rules.N.Escalations.Critical.Statistics, Rules.N.Escalations.Critical.ComparisonOperator, Rules.N.Escalations.Critical.Threshold, and Rules.N.Escalations.Critical.Times parameters, a collection of the Rules.N.Escalations.Warn.Statistics, Rules.N.Escalations.Warn.ComparisonOperator, Rules.N.Escalations.Warn.Threshold, and Rules.N.Escalations.Warn.Times parameters, or a collection of the Rules.N.Escalations.Info.Statistics, Rules.N.Escalations.Info.ComparisonOperator, Rules.N.Escalations.Info.Threshold, and Rules.N.Escalations.Info.Times parameters.
AlertTemplates.N.Escalations.Info.ComparisonOperator String No GreaterThanOrEqualToThreshold

The comparison operator that is used to compare the metric value with the threshold. Valid values of N: 1 to 200. Valid values:

  • GreaterThanOrEqualToThreshold: greater than or equal to the threshold
  • GreaterThanThreshold: greater than the threshold
  • LessThanOrEqualToThreshold: less than or equal to the threshold
  • LessThanThreshold: less than the threshold
  • NotEqualToThreshold: not equal to the threshold
  • GreaterThanYesterday: greater than the metric value at the same time yesterday
  • LessThanYesterday: less than the metric value at the same time yesterday
  • GreaterThanLastWeek: greater than the metric value at the same time last week
  • LessThanLastWeek: less than the metric value at the same time last week
  • GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle
  • LessThanLastPeriod: less than the metric value in the last monitoring cycle
Note You must set a collection of the Rules.N.Escalations.Critical.Statistics, Rules.N.Escalations.Critical.ComparisonOperator, Rules.N.Escalations.Critical.Threshold, and Rules.N.Escalations.Critical.Times parameters, a collection of the Rules.N.Escalations.Warn.Statistics, Rules.N.Escalations.Warn.ComparisonOperator, Rules.N.Escalations.Warn.Threshold, and Rules.N.Escalations.Warn.Times parameters, or a collection of the Rules.N.Escalations.Info.Statistics, Rules.N.Escalations.Info.ComparisonOperator, Rules.N.Escalations.Info.Threshold, and Rules.N.Escalations.Info.Times parameters.
AlertTemplates.N.Escalations.Info.Threshold String No 90

The threshold for Info-level alerts. Valid values of N: 1 to 200.

Note You must set a collection of the Rules.N.Escalations.Critical.Statistics, Rules.N.Escalations.Critical.ComparisonOperator, Rules.N.Escalations.Critical.Threshold, and Rules.N.Escalations.Critical.Times parameters, a collection of the Rules.N.Escalations.Warn.Statistics, Rules.N.Escalations.Warn.ComparisonOperator, Rules.N.Escalations.Warn.Threshold, and Rules.N.Escalations.Warn.Times parameters, or a collection of the Rules.N.Escalations.Info.Statistics, Rules.N.Escalations.Info.ComparisonOperator, Rules.N.Escalations.Info.Threshold, and Rules.N.Escalations.Info.Times parameters.
AlertTemplates.N.Escalations.Info.Times Integer No 3

The consecutive number of times for which the metric value meets the alert condition before an Info-level alert is triggered. Valid values of N: 1 to 200.

Note You must set a collection of the Rules.N.Escalations.Critical.Statistics, Rules.N.Escalations.Critical.ComparisonOperator, Rules.N.Escalations.Critical.Threshold, and Rules.N.Escalations.Critical.Times parameters, a collection of the Rules.N.Escalations.Warn.Statistics, Rules.N.Escalations.Warn.ComparisonOperator, Rules.N.Escalations.Warn.Threshold, and Rules.N.Escalations.Warn.Times parameters, or a collection of the Rules.N.Escalations.Info.Statistics, Rules.N.Escalations.Info.ComparisonOperator, Rules.N.Escalations.Info.Threshold, and Rules.N.Escalations.Info.Times parameters.
AlertTemplates.N.Webhook String No http://ww.aliyun.com

The callback URL. Valid values of N: 1 to 200.

The callback URL must be accessible over the Internet. CloudMonitor sends a POST request to push an alert notification to the callback URL that you specify. Only HTTP requests are supported.

For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
RequestId String 9763ED1A-4D09-41BF-851E-310421750204

The ID of the request.

Success Boolean true

Indicates whether the call was successful. Valid values:

  • true: The call was successful.
  • false: The call failed.
Code Integer 200

The HTTP status code.

Note The status code 200 indicates that the call was successful.
Id Long 12345

The ID of the alert template.

Message String The Request is not authorization.

The error message.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateMetricRuleTemplate
&Name=Template_test
&AlertTemplates.1.MetricName=cpu_total
&AlertTemplates.1.RuleName=Rule_test
&AlertTemplates.1.Category=ecs
&AlertTemplates.1.Namespace=acs_ecs_dashboard
&<Common request parameters>

Sample success responses

XML format

<CreateMetricRuleTemplateResponse>
		  <RequestId>9763ED1A-4D09-41BF-851E-310421750204</RequestId>
		  <Id>12345</Id>
		  <Success>true</Success>
		  <Code>200</Code>
</CreateMetricRuleTemplateResponse>

JSON format

{
    "RequestId": "9763ED1A-4D09-41BF-851E-310421750204",
    "Id": 12345,
    "Success": true,
    "Code": 200
}

Error codes

For a list of error codes, visit the API Error Center.