调用DescribeMetricRuleBlackList接口查询报警黑名单策略列表-阿里云帮助中心

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeMetricRuleBlackList	要执行的操作，取值：DescribeMetricRuleBlackList。
Namespace	String	否	acs_ecs_dashboard	云服务的数据命名空间。关于云服务的命名空间，请参见云服务监控项。
PageNumber	Integer	否	1	当前页码。默认值：1。
PageSize	Integer	否	100	每页显示的记录条数。默认值：10。
Order	Integer	否	DESC	查询结果按时间的排序方式。取值： DESC（默认值）：降序。 ASC：升序。
Category	String	否	ecs	云服务分类。例如：Redis有`kvstore_standard`（标准版）、`kvstore_sharding`（集群版）和`kvstore_splitrw`（读写分离版）等。
Ids.N	String	否	a9ad2ac2-3ed9-11ed-b878-0242ac12****	报警黑名单策略的ID。
Name	String	否	Blacklist-01	报警黑名单策略名称。该参数支持模糊查询。
ScopeType	String	否	USER	报警黑名单策略的生效范围。取值： USER：报警黑名单策略仅在当前阿里云账号中生效。 GROUP：报警黑名单策略在指定应用分组中生效。
IsEnable	Boolean	否	true	报警黑名单策略的启用状态。取值： true：启用。 false：禁用。
InstanceIds.N	String	否	i-2ze2d6j5uhg20x47****	报警黑名单策略中的实例ID。

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

返回数据


名称	类型	示例值	描述
Code	String	200	状态码。说明 200表示成功。
Message	String	The Request is not authorization.	错误信息。
RequestId	String	D63E76CB-29AA-5B9F-88CE-400A6F28D428	请求ID。
Total	Integer	1	报警黑名单策略的总条数。
Success	Boolean	true	操作是否成功。取值： true：成功。 false：失败。
DescribeMetricRuleBlackList	Array of DescribeMetricRuleBlackList		报警黑名单策略列表。
EffectiveTime	String	00:00-23:59	报警黑名单策略的生效时间范围。
UpdateTime	String	1665718373000	修改报警黑名单策略的时间戳。单位：毫秒。
CreateTime	String	1665714561000	创建报警黑名单策略的时间戳。单位：毫秒。
ScopeType	String	USER	报警黑名单策略的生效范围。取值： USER：报警黑名单策略仅在当前阿里云账号中生效。 GROUP：报警黑名单策略在指定应用分组中生效。
IsEnable	Boolean	true	报警黑名单策略的状态。取值： true：启用。 false：禁用。
Namespace	String	acs_ecs_dashboard	云服务的数据命名空间。
Category	String	ecs	云服务分类。例如：Redis有`kvstore_standard`（标准版）、`kvstore_sharding`（集群版）和`kvstore_splitrw`（读写分离版）等。
EnableEndTime	Long	1640608200000	报警黑名单策略的开始时间戳。单位：毫秒。
Name	String	Blacklist-01	报警黑名单策略的名称。
EnableStartTime	Long	1640237400000	报警黑名单策略的结束时间戳。单位：毫秒。
Id	String	93514c96-ceb8-47d8-8ee3-93b6d98b****	报警黑名单策略的ID。
Metrics	Array of Metrics		实例中的监控指标。
Resource	String	[{"device":"C:"}]	实例的扩展维度信息。例如：`{"device":"C:"}`，表示对云服务器ECS实例下的所有C盘应用黑名单策略。
MetricName	String	disk_utilization	监控指标名称。
Instances	Array of String	i-rj99xc6cptkk64ml****	报警黑名单策略中指定云服务的实例列表。
ScopeValue	Array of String	["67**","78**"]	应用分组ID列表。格式为JSON Array。说明仅当`ScopeType`为`GROUP`时，显示该参数。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeMetricRuleBlackList
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeMetricRuleBlackListResponse>
    <RequestId>D63E76CB-29AA-5B9F-88CE-400A6F28D428</RequestId>
    <Total>1</Total>
    <DescribeMetricRuleBlackList>
        <ScopeType>USER</ScopeType>
        <Instances>
            <instancceId>i-rj99xc6cptkk64ml****</instancceId>
        </Instances>
        <IsEnable>true</IsEnable>
        <Metrics>
            <MetricName>disk_utilization</MetricName>
            <Resource/>
        </Metrics>
        <Category>ecs</Category>
        <CreateTime>1635714561000</CreateTime>
        <UpdateTime>1635718373000</UpdateTime>
        <Id>93514c96-ceb8-47d8-8ee3-93b6d98b****</Id>
        <Namespace>acs_ecs_dashboard</Namespace>
        <Name>Blacklist-01</Name>
    </DescribeMetricRuleBlackList>
    <Success>true</Success>
</DescribeMetricRuleBlackListResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "D63E76CB-29AA-5B9F-88CE-400A6F28D428",
  "Total" : 1,
  "DescribeMetricRuleBlackList" : [ {
    "ScopeType" : "USER",
    "Instances" : [ {
      "instancceId" : "i-rj99xc6cptkk64ml****"
    } ],
    "IsEnable" : true,
    "Metrics" : [ {
      "MetricName" : "disk_utilization",
      "Resource" : ""
    } ],
    "Category" : "ecs",
    "CreateTime" : 1635714561000,
    "UpdateTime" : 1635718373000,
    "Id" : "93514c96-ceb8-47d8-8ee3-93b6d98b****",
    "Namespace" : "acs_ecs_dashboard",
    "Name" : "Blacklist-01"
  } ],
  "Success" : true
}

错误码


HttpCode	错误码	错误信息	描述
404	ResourceNotFound	The specified resource is not found.	未找到指定资源。

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