Queries details about one-click alert rules.

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 DescribeActiveMetricRuleList

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

Product String Yes ecs

The abbreviation of the service name. The following services support one-click alert:

  • ecs: Elastic Compute Service (ECS)
  • rds: ApsaraDB for RDS
  • slb: Server Load Balancer (SLB)
  • redis_standard: ApsaraDB for Redis of the standard architecture
  • redis_sharding: ApsaraDB for Redis of the cluster architecture
  • redis_splitrw: ApsaraDB for Redis of the read/write splitting architecture
  • mongodb: ApsaraDB for MongoDB of the replica set architecture
  • mongodb_sharding: ApsaraDB for MongoDB of the sharded cluster architecture
  • hbase: ApsaraDB for Hbase
  • elasticsearch: Elasticsearch
  • opensearch: Open Search

Response parameters

Parameter Type Example Description
Code String 200

The HTTP status code. The status code 200 indicates that the call was successful.

Datapoints Array

The information about alert rules.

Alarm

The information about the alert rule.

ComparisonOperator String >

The comparison operator used in the alert rule.

ContactGroups String Alert contacts under the Alibaba Cloud account

The alert group.

Enable String true

The status of the alert rule. Valid values:

  • true: indicates that the alert rule is enabled.
  • false: indicates that the alert rule is disabled.
EndTime String 24

The end time of the time period during which the alert rule is effective. The value 23 indicates 23:59:59.

EvaluationCount String 3

The consecutive number of times for which the metric value is measured before an alert is triggered.

MetricName String cpu_total

The name of the metric.

Namespace String acs_ecs_dashboard

The namespace of the service. You can call the DescribeMetricMetaList operation to query namespaces. For more information about namespaces, see Appendix 1: Metrics.

Period String 60

The aggregation period of monitoring data. Unit: seconds. The default value is the highest frequency at which the metric is polled. Typically, you do not need to specify the minimum frequency.

RuleId String a151cd6023eacee2f0978e03863cc1697c89508****

The ID of the alert rule.

RuleName String SystemDefault_acs_rds_dashboard_CpuUsage

The name of the alert rule.

SilenceTime String 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.

StartTime String 00

The start time of the time period during which the alert rule is effective. The value 00 indicates 00:00:00.

State String Enable

Indicates whether the alert rule is enabled.

Statistics String Average

The statistical method.

Threshold String 90

The threshold of the metric value.

Webhook String http://www.aliyun.com

The callback URL.

Message String success

The returned message.

RequestId String F82E6667-7811-4BA0-842F-5B2DC42BBAAD

The ID of the request.

Success Boolean true

Indicates whether the call was successful.

Examples

Sample requests


http(s)://[Endpoint]/?Action=DescribeActiveMetricRuleList
&Product=ecs
&<Common request parameters>

Sample success responses

XML format

<DescribeActiveMetricRuleListResponse>
      <Code>200</Code>
      <Success>true</Success>
      <Datapoints>
        <Alarm>
              <Namespace>acs_rds_dashboard</Namespace>
              <Statistics>Average</Statistics>
              <Uuid>ef983030-c143-4b1b-b6c7-d4227c99****</Uuid>
              <ContactGroups>["Alert contacts under the Alibaba Cloud account"]</ContactGroups>
              <Webhook>null</Webhook>
              <EvaluationCount>5</EvaluationCount>
              <Period>300</Period>
              <NotifyType>0</NotifyType>
              <State>OK</State>
              <Enable>true</Enable>
              <StartTime>0</StartTime>
              <EndTime>24</EndTime>
              <RuleName>SystemDefault_acs_rds_dashboard_CpuUsage</RuleName>
              <Threshold>80</Threshold>
              <MetricName>CpuUsage#300</MetricName>
              <ComparisonOperator>&gt;</ComparisonOperator>
              <SilenceTime>86400</SilenceTime>
              <Name>SystemDefault_acs_rds_dashboard_CpuUsage</Name>
        </Alarm>
        <Alarm>
              <Namespace>acs_rds_dashboard</Namespace>
              <Statistics>Average</Statistics>
              <Uuid>30b95d23-627e-4e3f-bd8a-b41099aa****</Uuid>
              <ContactGroups>["Alert contacts under the Alibaba Cloud account"]</ContactGroups>
              <Webhook>null</Webhook>
              <EvaluationCount>5</EvaluationCount>
              <Period>300</Period>
              <NotifyType>1</NotifyType>
              <State>OK</State>
              <Enable>true</Enable>
              <StartTime>0</StartTime>
              <EndTime>24</EndTime>
              <RuleName>SystemDefault_acs_rds_dashboard_DiskUsage</RuleName>
              <Threshold>80</Threshold>
              <MetricName>DiskUsage#300</MetricName>
              <ComparisonOperator>&gt;</ComparisonOperator>
              <SilenceTime>86400</SilenceTime>
              <Name>SystemDefault_acs_rds_dashboard_DiskUsage</Name>
        </Alarm>
        <Alarm>
              <Namespace>acs_rds_dashboard</Namespace>
              <Statistics>Average</Statistics>
              <Uuid>2a657281-ae3b-45e7-8ee6-0346bc83****</Uuid>
              <ContactGroups>["Alert contacts under the Alibaba Cloud account"]</ContactGroups>
              <Webhook>null</Webhook>
              <EvaluationCount>5</EvaluationCount>
              <Period>300</Period>
              <NotifyType>0</NotifyType>
              <State>OK</State>
              <Enable>true</Enable>
              <StartTime>0</StartTime>
              <EndTime>24</EndTime>
              <RuleName>SystemDefault_acs_rds_dashboard_IOPSUsage</RuleName>
              <Threshold>80</Threshold>
              <MetricName>IOPSUsage#300</MetricName>
              <ComparisonOperator>&gt;</ComparisonOperator>
              <SilenceTime>86400</SilenceTime>
              <Name>SystemDefault_acs_rds_dashboard_IOPSUsage</Name>
        </Alarm>
        <Alarm>
              <Namespace>acs_rds_dashboard</Namespace>
              <Statistics>Average</Statistics>
              <Uuid>c8c0cae5-2999-4fab-8b6e-1b8581cd****</Uuid>
              <ContactGroups>["Alert contacts under the Alibaba Cloud account"]</ContactGroups>
              <Webhook>null</Webhook>
              <EvaluationCount>5</EvaluationCount>
              <Period>300</Period>
              <NotifyType>0</NotifyType>
              <State>OK</State>
              <Enable>true</Enable>
              <StartTime>0</StartTime>
              <EndTime>24</EndTime>
              <RuleName>SystemDefault_acs_rds_dashboard_ConnectionUsage</RuleName>
              <Threshold>80</Threshold>
              <MetricName>ConnectionUsage#300</MetricName>
              <ComparisonOperator>&gt;</ComparisonOperator>
              <SilenceTime>86400</SilenceTime>
              <Name>SystemDefault_acs_rds_dashboard_ConnectionUsage</Name>
        </Alarm>
        <Alarm>
              <Namespace>acs_rds_dashboard</Namespace>
              <Statistics>Average</Statistics>
              <Uuid>22798954-b384-4b5a-b9cd-bf39bbf8ee5f</Uuid>
              <ContactGroups>["Alert contacts under the Alibaba Cloud account"]</ContactGroups>
              <Webhook>null</Webhook>
              <EvaluationCount>5</EvaluationCount>
              <Period>300</Period>
              <NotifyType>0</NotifyType>
              <State>INSUFFICIENT_DATA</State>
              <Enable>true</Enable>
              <StartTime>0</StartTime>
              <EndTime>24</EndTime>
              <RuleName>SystemDefault_acs_rds_dashboard_DataDelay</RuleName>
              <Threshold>5</Threshold>
              <MetricName>DataDelay#300</MetricName>
              <ComparisonOperator>&gt;</ComparisonOperator>
              <SilenceTime>86400</SilenceTime>
              <Name>SystemDefault_acs_rds_dashboard_DataDelay</Name>
        </Alarm>
      </Datapoints>
</DescribeActiveMetricRuleListResponse>

JSON format

{
	"Datapoints":{
		"Alarm":[
			{
				"Uuid":"ef983030-c143-4b1b-b6c7-d4227c99****",
				"Period":300,
				"Statistics":"Average",
				"Webhook":"null",
				"RuleName":"SystemDefault_acs_rds_dashboard_CpuUsage",
				"EvaluationCount":5,
				"Name":"SystemDefault_acs_rds_dashboard_CpuUsage",
				"MetricName":"CpuUsage#300",
				"Threshold":"80",
				"State":"OK",
				"Enable":true,
				"SilenceTime":86400,
				"NotifyType":0,
				"Namespace":"acs_rds_dashboard",
				"ContactGroups":"[\"Alert contacts under the Alibaba Cloud account\"]",
				"EndTime":24,
				"StartTime":0,
				"ComparisonOperator":">"
			},
			{
				"Uuid":"30b95d23-627e-4e3f-bd8a-b41099aa****",
				"Period":300,
				"Statistics":"Average",
				"Webhook":"null",
				"RuleName":"SystemDefault_acs_rds_dashboard_DiskUsage",
				"EvaluationCount":5,
				"Name":"SystemDefault_acs_rds_dashboard_DiskUsage",
				"MetricName":"DiskUsage#300",
				"Threshold":"80",
				"State":"OK",
				"Enable":true,
				"SilenceTime":86400,
				"NotifyType":1,
				"Namespace":"acs_rds_dashboard",
				"ContactGroups":"[\"Alert contacts under the Alibaba Cloud account\"]",
				"EndTime":24,
				"StartTime":0,
				"ComparisonOperator":">"
			},
			{
				"Uuid":"2a657281-ae3b-45e7-8ee6-0346bc83****",
				"Period":300,
				"Statistics":"Average",
				"Webhook":"null",
				"RuleName":"SystemDefault_acs_rds_dashboard_IOPSUsage",
				"EvaluationCount":5,
				"Name":"SystemDefault_acs_rds_dashboard_IOPSUsage",
				"MetricName":"IOPSUsage#300",
				"Threshold":"80",
				"State":"OK",
				"Enable":true,
				"SilenceTime":86400,
				"NotifyType":0,
				"Namespace":"acs_rds_dashboard",
				"ContactGroups":"[\"Alert contacts under the Alibaba Cloud account\"]",
				"EndTime":24,
				"StartTime":0,
				"ComparisonOperator":">"
			},
			{
				"Uuid":"c8c0cae5-2999-4fab-8b6e-1b8581cd****",
				"Period":300,
				"Statistics":"Average",
				"Webhook":"null",
				"RuleName":"SystemDefault_acs_rds_dashboard_ConnectionUsage",
				"EvaluationCount":5,
				"Name":"SystemDefault_acs_rds_dashboard_ConnectionUsage",
				"MetricName":"ConnectionUsage#300",
				"Threshold":"80",
				"State":"OK",
				"Enable":true,
				"SilenceTime":86400,
				"NotifyType":0,
				"Namespace":"acs_rds_dashboard",
				"ContactGroups":"[\"Alert contacts under the Alibaba Cloud account\"]",
				"EndTime":24,
				"StartTime":0,
				"ComparisonOperator":">"
			},
			{
				"Uuid":"22798954-b384-4b5a-b9cd-bf39bbf8****",
				"Period":300,
				"Statistics":"Average",
				"Webhook":"null",
				"RuleName":"SystemDefault_acs_rds_dashboard_DataDelay",
				"EvaluationCount":5,
				"Name":"SystemDefault_acs_rds_dashboard_DataDelay",
				"MetricName":"DataDelay#300",
				"Threshold":"5",
				"State":"INSUFFICIENT_DATA",
				"Enable":true,
				"SilenceTime":86400,
				"NotifyType":0,
				"Namespace":"acs_rds_dashboard",
				"ContactGroups":"[\"Alert contacts under the Alibaba Cloud account\"]",
				"EndTime":24,
				"StartTime":0,
				"ComparisonOperator":">"
			}
		]
	},
	"Success":true,
	"Code":"200"
}

Error codes

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