文档

DescribeMetricRuleBlackList - 查询报警黑名单策略列表

更新时间:

调用DescribeMetricRuleBlackList接口查询报警黑名单策略列表。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
Namespacestring

云服务的数据命名空间。

关于云服务的命名空间,请参见云服务监控项

acs_ecs_dashboard
PageNumberinteger

当前页码。

默认值:1。

1
PageSizeinteger

每页显示的记录条数。

默认值:10。

100
Orderinteger

查询结果按时间的排序方式。取值:

  • DESC(默认值):降序。

  • ASC:升序。

DESC
Categorystring

云服务分类。例如:Redis 有kvstore_standard(标准版)、kvstore_sharding(集群版)和kvstore_splitrw(读写分离版)等。

ecs
Idsarray

报警黑名单策略的 ID 列表。

string

报警黑名单策略的 ID。

a9ad2ac2-3ed9-11ed-b878-0242ac12****
Namestring

报警黑名单策略名称。

该参数支持模糊查询。

Blacklist-01
ScopeTypestring

报警黑名单策略的生效范围。取值:

  • USER:报警黑名单策略仅在当前阿里云账号中生效。

  • GROUP:报警黑名单策略在指定应用分组中生效。

USER
IsEnableboolean

报警黑名单策略的启用状态。取值:

  • true:启用。
  • false:禁用。
true
InstanceIdsarray

报警黑名单策略中的实例 ID 列表。

N 的取值范围:0~10。

string

报警黑名单策略中的实例 ID。

i-2ze2d6j5uhg20x47****

关于公共请求参数的详情,请参见公共参数

返回参数

名称类型描述示例值
object

无。

Codestring

状态码。

说明 200 表示成功。
200
Messagestring

错误信息。

The Request is not authorization.
RequestIdstring

请求 ID。

D63E76CB-29AA-5B9F-88CE-400A6F28D428
Totalinteger

报警黑名单策略的总条数。

1
Successboolean

操作是否成功。取值:

  • true:成功。

  • false:失败。

true
DescribeMetricRuleBlackListobject []

报警黑名单策略列表。

EffectiveTimestring

报警黑名单策略的生效时间范围。

00:00-23:59
UpdateTimestring

修改报警黑名单策略的时间戳。

单位:毫秒。

1665718373000
CreateTimestring

创建报警黑名单策略的时间戳。

单位:毫秒。

1665714561000
ScopeTypestring

报警黑名单策略的生效范围。取值:

  • USER:报警黑名单策略仅在当前阿里云账号中生效。

  • GROUP:报警黑名单策略在指定应用分组中生效。

USER
IsEnableboolean

报警黑名单策略的状态。取值:

  • true:启用。

  • false:禁用。

true
Namespacestring

云服务的数据命名空间。

acs_ecs_dashboard
Categorystring

云服务分类。例如:Redis 有kvstore_standard(标准版)、kvstore_sharding(集群版)和kvstore_splitrw(读写分离版)等。

ecs
EnableEndTimelong

报警黑名单策略的开始时间戳。

单位:毫秒。

1640608200000
Namestring

报警黑名单策略的名称。

Blacklist-01
EnableStartTimelong

报警黑名单策略的结束时间戳。

单位:毫秒。

1640237400000
Idstring

报警黑名单策略的 ID。

93514c96-ceb8-47d8-8ee3-93b6d98b****
Metricsobject []

实例中的监控指标。

Resourcestring

实例的扩展维度信息。例如:{"device":"C:"},表示对云服务器 ECS 实例下的所有 C 盘应用黑名单策略。

[{"device":"C:"}]
MetricNamestring

监控指标名称。

disk_utilization
Instancesarray

报警黑名单策略中指定云服务的实例列表。

string

报警黑名单策略中指定云服务的实例列表。

i-rj99xc6cptkk64ml****
ScopeValuearray

应用分组 ID 列表。

string

应用分组 ID 列表。格式为 JSON Array。

说明 仅当ScopeTypeGROUP时,显示该参数。
["67****","78****"]

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "The Request is not authorization.",
  "RequestId": "D63E76CB-29AA-5B9F-88CE-400A6F28D428",
  "Total": 1,
  "Success": true,
  "DescribeMetricRuleBlackList": [
    {
      "EffectiveTime": "00:00-23:59",
      "UpdateTime": "1665718373000",
      "CreateTime": "1665714561000",
      "ScopeType": "USER",
      "IsEnable": true,
      "Namespace": "acs_ecs_dashboard",
      "Category": "ecs",
      "EnableEndTime": 1640608200000,
      "Name": "Blacklist-01",
      "EnableStartTime": 1640237400000,
      "Id": "93514c96-ceb8-47d8-8ee3-93b6d98b****",
      "Metrics": [
        {
          "Resource": "[{\"device\":\"C:\"}]",
          "MetricName": "disk_utilization"
        }
      ],
      "Instances": [
        "i-rj99xc6cptkk64ml****"
      ],
      "ScopeValue": [
        "[\"67****\",\"78****\"]"
      ]
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400ParameterInvalidIllegal parameters.-
403AccessForbiddenUser not authorized to operate on the specified resource.-
404ResourceNotFoundThe specified resource is not found.未找到指定资源。
409ResourceConflictConcurrent modification of resources.-
409ResourceExistResources already exist.-
500InternalErrorThe request processing has failed due to some unknown error.-

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

变更历史

变更时间变更内容概要操作
2023-07-11OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:409
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:Name
    新增入参:ScopeType
    新增入参:IsEnable
    新增入参:InstanceIds
2022-06-22新增 OpenAPI看变更集