PutGroupMetricRule - API Reference| Alibaba Cloud Documentation Center

Creates or modifies an alert rule for an application group.

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	PutGroupMetricRule	The operation that you want to perform. Set the value to PutGroupMetricRule.
Category	String	Yes	ecs	The abbreviation of the service name. Valid values: ecs: Elastic Compute Service (ECS) instances provided by Alibaba Cloud and hosts not provided by Alibaba Cloud rds: ApsaraDB for RDS ads: AnalyticDB slb: Server Load Balancer (SLB) vpc: Virtual Private Cloud (VPC) apigateway: API Gateway cdn: Alibaba Cloud Content Delivery Network (CDN) cs: Container Service for Swarm dcdn: Dynamic Route for CDN ddos: Anti-DDoS Pro eip: Elastic IP Address (EIP) elasticsearch: Elasticsearch emr: E-MapReduce ess: Auto Scaling hbase: ApsaraDB for Hbase iot_edge: IoT Edge k8s_pod: pods in Container Service for Kubernetes kvstore_sharding: ApsaraDB for Redis of the cluster architecture kvstore_splitrw: ApsaraDB for Redis of the read/write splitting architecture kvstore_standard: ApsaraDB for Redis of the standard architecture memcache: ApsaraDB for Memcache mns: Message Service (MNS) mongodb: ApsaraDB for MongoDB of the replica set architecture mongodb_cluster: ApsaraDB for MongoDB of the cluster architecture mongodb_sharding: ApsaraDB for MongoDB of the sharded cluster architecture mq_topic: MNS topics ocs: ApsaraDB for Memcache of earlier versions opensearch: Open Search oss: Object Storage Service (OSS) polardb: PolarDB petadata: HybridDB for MySQL scdn: Secure Content Delivery Network (SCDN) sharebandwidthpackages: EIP Bandwidth Plan sls: Log Service vpn: VPN Gateway Valid values of N: 1 to 200. Note More Alibaba Cloud services will be supported soon.
GroupId	String	Yes	123456	The ID of the application group.
MetricName	String	Yes	cpu_total	The name of the metric. Note For more information, see DescribeMetricMetaList or Appendix 1: Metrics.
Namespace	String	Yes	acs_ecs_dashboard	The namespace of the service. Note For more information, see DescribeMetricMetaList or Appendix 1: Metrics.
RuleId	String	Yes	bfae2ca5b4e07d2c7278772eccda169808c7b****	The ID of the alert rule.
Dimensions	String	No	[{"instanceId":"xxxxxx"}]	The dimensions that specify the resources to be associated with the alert rule. Set the value to a collection of `key-value` pairs. A typical `key-value` pair is `instanceId:XXXXXX`. The `key` and `value` must be 1 to 64 bytes in length, respectively. Excessive bytes are truncated from the string. The `key` and `value` can contain letters, digits, periods (.), hyphens (-), underscores (_), forward slashes (/), and backslashes (\). Note `Dimensions` must be organized in a JSON string and follow the required order.
EffectiveInterval	String	No	00:00-23:59	The time period during which the alert rule is effective.
EmailSubject	String	No	An alert occurs.	The subject of the alert notification email.
Escalations.Critical.ComparisonOperator	String	No	GreaterThanOrEqualToThreshold	The comparison operator of the threshold for critical-level alerts. 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
Escalations.Critical.Statistics	String	No	Average	The statistical method for critical-level alerts. Note For more information, see DescribeMetricMetaList.
Escalations.Critical.Threshold	String	No	90	The threshold for critical-level alerts.
Escalations.Critical.Times	Integer	No	3	The consecutive number of times for which the metric value is measured before a critical-level alert is triggered.
Escalations.Info.ComparisonOperator	String	No	GreaterThanOrEqualToThreshold	The comparison operator of the threshold for info-level alerts. 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
Escalations.Info.Statistics	String	No	Average	The statistical method for info-level alerts. Note For more information, see DescribeMetricMetaList.
Escalations.Info.Threshold	String	No	90	The threshold for info-level alerts.
Escalations.Info.Times	Integer	No	3	The consecutive number of times for which the metric value is measured before an info-level alert is triggered.
Escalations.Warn.ComparisonOperator	String	No	GreaterThanOrEqualToThreshold	The comparison operator of the threshold for warn-level alerts. 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
Escalations.Warn.Statistics	String	No	Average	The statistical method for warn-level alerts. Note For more information, see DescribeMetricMetaList.
Escalations.Warn.Threshold	String	No	90	The threshold for warn-level alerts.
Escalations.Warn.Times	Integer	No	3	The consecutive number of times for which the metric value is measured before a warn-level alert is triggered.
Interval	String	No	60	The interval at which Cloud Monitor checks whether the alert rule is triggered. The default value is the highest frequency at which the metric is polled. Unit: seconds. Note We recommend that you set this interval to the data aggregation period. If this interval is shorter than the data aggregation period, alerts cannot be triggered due to insufficient data.
NoEffectiveInterval	String	No	00:00-05:30	The time period during which the alert rule is ineffective.
Period	String	No	60	The aggregation cycle of monitoring data. The value is an integral multiple of 60. Unit: seconds. Default value: 300. Unit: seconds.
RuleName	String	No	Alert rule 1	The name of the alert rule.
SilenceTime	Integer	No	86400	The duration of the mute period during which new alerts are not sent even if the trigger conditions are met. Unit: seconds. Default value: 86400.
Webhook	String	No	http://www.aliyun.com	The callback URL.

Response parameters


Parameter	Type	Example	Description
RequestId	String	461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D	The ID of the request.
Success	Boolean	true	Indicates whether the call was successful.
Code	String	200	The HTTP status code. Note The status code 200 indicates that the call was successful.
Message	String	success	The returned message.

Examples

Sample requests


http(s)://[Endpoint]/?Action=PutGroupMetricRule
&Category=ecs
&GroupId=123456
&MetricName=cpu_total
&Namespace=acs_ecs_dashboard
&RuleId=bfae2ca5b4e07d2c7278772eccda169808c7b****
&<Common request parameters>

Sample success responses

XML format

<RequestId>26C766DE-E759-4B38-8B23-28589C491CEF</RequestId>
<Code>200</Code>
<Success>true</Success>

JSON format

{
	"RequestId":"26C766DE-E759-4B38-8B23-28589C491CEF",
	"Success":true,
	"Code":200
}

Error codes

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