文档

DescribeProductsOfActiveMetricRule - 查询开通一键报警规则的云服务列表

更新时间:

调用DescribeProductsOfActiveMetricRule接口查询开通一键报警规则的云服务列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cms:DescribeProductsOfActiveMetricRuleRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
当前API无需请求参数

返回参数

名称类型描述示例值
object

无。

Codeinteger

状态码。

说明 200 表示成功。
200
Messagestring

错误信息。

The Request is not authorization.
RequestIdstring

请求 ID。

F82E6667-7811-4BA0-842F-5B2DC42BBAAD
Datapointsstring

开通一键报警的云服务列表。云服务之间用英文逗号(,)分隔。取值:

  • ecs:云服务器 ECS。
  • rds:云数据库 RDS 版。
  • slb:负载均衡。
  • redis_standard:云数据库 Redis 标准版。
  • redis_sharding:云数据库 Redis 集群版。
  • redis_splitrw:云数据库 Redis 读写分离版。
  • mongodb:云数据库 MongoDB 版(副本集)。
  • mongodb_sharding:云数据库 MongoDB 版(分片集群)。
  • hbase:云数据库 HBase 版。
  • elasticsearch:Elasticsearch。
  • opensearch:OpenSearch。
ecs,rds
Successboolean

操作是否成功。取值:

  • true:成功。

  • false:失败。

true
AllProductInitMetricRuleListobject []

开通一键报警的云服务列表。

Productstring

阿里云服务缩写。

ecs
AlertInitConfigListobject []

初始化开通一键报警云服务的规则列表。

MetricNamestring

监控项名称。详情请参见云服务监控项

cpu_total
EvaluationCountstring

报警重试次数。

3
Namespacestring

指标所属空间。用于区分每个云服务配置。详情请参见云服务监控项

acs_rds_dashboard
Thresholdstring

报警阈值。

90
Statisticsstring

报警统计方法。详情请参见云服务监控项

Average
Periodstring

监控数据的聚合周期。单位:分钟。详情请参见云服务监控项

1m
Levelstring

报警级别。

枚举值:
  • INFO信息
  • WARN警告
  • CRITICAL紧急
CRITICAL
ComparisonOperatorstring

警告级别阈值比较符。

枚举值:
  • LessThanThreshold小于
  • GreaterThanLastWeek同比上周同一时间上涨
  • LessThanOrEqualToThreshold小于等于
  • NotEqualToThreshold不等于
  • GreaterThanLastPeriod环比上周期上涨
  • GreaterThanYesterday同比昨天时间上涨
  • LessThanYesterday同比昨天时间下降
  • LessThanLastWeek同比上周同一时间下降
  • GreaterThanOrEqualToThreshold大于等于
  • GreaterThanThreshold大于
  • LessThanLastPeriod环比上周期下降
GreaterThanOrEqualToThreshold

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "The Request is not authorization.",
  "RequestId": "F82E6667-7811-4BA0-842F-5B2DC42BBAAD",
  "Datapoints": "ecs,rds",
  "Success": true,
  "AllProductInitMetricRuleList": {
    "AllProductInitMetricRule": [
      {
        "Product": "ecs",
        "AlertInitConfigList": {
          "AlertInitConfig": [
            {
              "MetricName": "cpu_total",
              "EvaluationCount": "3",
              "Namespace": "acs_rds_dashboard",
              "Threshold": "90",
              "Statistics": "Average",
              "Period": "1m",
              "Level": "CRITICAL",
              "ComparisonOperator": "GreaterThanOrEqualToThreshold"
            }
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息
400InvalidParameterThe specified parameter is not valid.
403InvalidAuthorizationThe Request is not authorization.
406%s%s
500InternalErrorThe request processing has failed due to some unknown error.

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-10-25OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:406
    删除错误码:500
出参OpenAPI 返回结构发生变更