调用DescribeMetricRuleList接口查询报警规则列表中的所有规则。
接口说明
本文将提供一个示例，查询当前阿里云账号下的报警规则列表中的所有报警规则。返回结果显示，报警规则列表中只有一条报警规则，该报警规则的名称为Rule_01、ID 为applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| cms:DescribeMetricRuleList | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| MetricName | string | 否 | 监控项名称。 关于如何获取监控项名称，请参见 DescribeMetricMetaList 或云产品监控项。 | cpu_total |
| EnableState | boolean | 否 | 报警规则的启用状态。取值：
| true |
| Namespace | string | 否 | 云产品的命名空间。 关于如何获取云产品的命名空间，请参见 DescribeMetricMetaList 或云产品监控项。 | acs_ecs_dashboard |
| Page | integer | 否 | 页码。 起始值：1。默认值：1。 | 1 |
| PageSize | integer | 否 | 分页时每页显示的数据行数。 起始值：1。默认值：10。 | 10 |
| AlertState | string | 否 | 报警规则状态。取值：
| OK |
| Dimensions | string | 否 | 指定资源的监控维度。 格式： | {"instanceId":"i-2ze2d6j5uhg20x47****"} |
| RuleName | string | 否 | 报警规则名称。 该参数支持模糊查询。 | Rule_01 |
| GroupId | string | 否 | 应用分组 ID。 关于如何获取应用分组 ID，请参见 DescribeMonitorGroups 。 | 7301**** |
| RuleIds | string | 否 | 报警规则 ID。多个报警规则 ID 之间用半角逗号（,）分隔，一次最多可查询 20 条。 | applyTemplate344cfd42-0f32-4fd6-805a-88d7908a**** |
关于公共请求参数的详情，请参见公共参数。
返回参数
示例
正常返回示例
JSON格式
{
"Code": 200,
"Message": "The specified resource is not found.",
"RequestId": "386C6712-335F-5054-930A-CC92B851ECBA",
"Total": "1",
"Success": true,
"Alarms": {
"Alarm": [
{
"SilenceTime": 86400,
"MetricName": "cpu_total",
"Webhook": "https://www.aliyun.com",
"ContactGroups": "ECS_Alarm",
"SourceType": "METRIC",
"Namespace": "acs_ecs_dashboard",
"MailSubject": "\"${serviceType}-${metricName}-${levelDescription}通知（${dimensions}）\"",
"NoEffectiveInterval": "00:00-05:30",
"EffectiveInterval": "05:31-23:59",
"RuleName": "Rule_01",
"AlertState": "OK",
"Period": "60",
"RuleId": "applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****",
"GroupName": "ECS_Group",
"GroupId": "7301****",
"Dimensions": "[{\"instanceId\":\"i-2ze2d6j5uhg20x47****\"}]",
"EnableState": true,
"Resources": "[{\\\"instanceId\\\":\\\"i-2ze2d6j5uhg20x47****\\\"}]",
"Escalations": {
"Info": {
"ComparisonOperator": "GreaterThanOrEqualToThreshold",
"PreCondition": "$Average>80",
"Times": 3,
"Threshold": "90",
"Statistics": "Average"
},
"Warn": {
"ComparisonOperator": "GreaterThanOrEqualToThreshold",
"PreCondition": "$Average>80",
"Times": 3,
"Threshold": "90",
"Statistics": "Average"
},
"Critical": {
"ComparisonOperator": "GreaterThanOrEqualToThreshold",
"PreCondition": "$Average>80",
"Times": 3,
"Threshold": "90",
"Statistics": "Average"
}
},
"NoDataPolicy": "KEEP_LAST_STATE",
"CompositeExpression": {
"Level": "CRITICAL",
"ExpressionList": {
"ExpressionList": [
{
"MetricName": "cpu_total",
"Period": 60,
"Statistics": "$Maximum",
"ComparisonOperator": "GreaterThanOrEqualToThreshold",
"Threshold": "90"
}
]
},
"ExpressionListJoin": "||",
"ExpressionRaw": "$Average > ($instanceId == 'i-io8kfvcpp7x5****'? 80: 50)",
"Times": 3
},
"Labels": {
"Labels": [
{
"Key": "cmsRuleKey",
"Value": "cmsRuleValue"
}
]
},
"Prometheus": {
"PromQL": "CpuUsage{instanceId=\"xxxx\"}[1m]>90",
"Level": "CRITICAL",
"Times": 3,
"Annotations": {
"Annotations": [
{
"Key": "summary",
"Value": "{{ $labels.instance }} CPU usage above 10% {current value: {{ humanizePercentage $value }} }"
}
]
}
}
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParameter | The specified parameter is not valid. | - |
| 403 | InvalidAuthorization | The Request is not authorization. | - |
| 404 | ResourceNotFound | The specified resource is not found. | 未找到指定资源。 |
| 500 | InternalError | The request processing has failed due to some unknown error. | - |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-08-29 | OpenAPI 错误码发生变更 | 查看变更详情 |