Call DescribeMetricRuleBlackList to query blacklist policies - Cloud Monitor

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	DescribeMetricRuleBlackList	The operation that you want to perform. Set the value to DescribeMetricRuleBlackList.
Namespace	String	No	acs_ecs_dashboard	The namespace of the cloud service. For more information about the namespaces of different cloud services, see Appendix 1: Metrics.
PageNumber	Integer	No	1	The page number. Default value: 1.
PageSize	Integer	No	100	The number of entries per page. Default value: 10.
Order	Integer	No	DESC	The method that is used to sort query results by time. Valid values: DESC (default): descending order ASC: ascending order
Category	String	No	ecs	The category of the Alibaba Cloud service. For example, ApsaraDB for Redis includes the following categories: ApsaraDB for Redis (standard architecture), ApsaraDB for Redis (cluster architecture), and ApsaraDB for Redis (read/write splitting architecture). In this case, the valid values of this parameter for ApsaraDB for Redis include `kvstore_standard`, `kvstore_sharding`, and `kvstore_splitrw`.
Ids.N	String	No	a9ad2ac2-3ed9-11ed-b878-0242ac12****	The ID of the blacklist policy.
Name	String	No	Blacklist-01	The name of the blacklist policy. This parameter supports fuzzy match.
ScopeType	String	No	USER	The effective scope of the blacklist policy. Valid values: USER: The blacklist policy takes effect only within the current Alibaba Cloud account. GROUP: The blacklist policy takes effect only within the specified application group.
IsEnable	Boolean	No	true	The status of the blacklist policy. Valid values: true: The blacklist policy is enabled. false: The blacklist policy is disabled.
InstanceIds.N	String	No	i-2ze2d6j5uhg20x47****	The ID of the instance in the blacklist policy.

For more information about common request parameters, see Common parameters.

Response parameters

Parameter	Type	Example	Description
Code	String	200	The HTTP status code. Note The status code 200 indicates that the request was successful.
Message	String	The Request is not authorization.	The error message.
RequestId	String	D63E76CB-29AA-5B9F-88CE-400A6F28D428	The request ID.
Total	Integer	1	The total number of blacklist policies.
Success	Boolean	true	Indicates whether the request was successful. Valid values: true false
DescribeMetricRuleBlackList	Array of DescribeMetricRuleBlackList		The queried blacklist policies.
EffectiveTime	String	00:00-23:59	The time range within which the blacklist policy is effective.
UpdateTime	String	1665718373000	The timestamp when the blacklist policy was modified. Unit: milliseconds.
CreateTime	String	1665714561000	The timestamp when the blacklist policy was created. Unit: milliseconds.
ScopeType	String	USER	The effective scope of the blacklist policy. Valid values: USER: The blacklist policy takes effect only within the current Alibaba Cloud account. GROUP: The blacklist policy takes effect only within the specified application group.
IsEnable	Boolean	true	The status of the blacklist policy. Valid values: true: The blacklist policy is enabled. false: The blacklist policy is disabled.
Namespace	String	acs_ecs_dashboard	The namespace of the cloud service.
Category	String	ecs	The category of the Alibaba Cloud service. For example, ApsaraDB for Redis includes the following categories: ApsaraDB for Redis (standard architecture), ApsaraDB for Redis (cluster architecture), and ApsaraDB for Redis (read/write splitting architecture). In this case, the valid values of this parameter for ApsaraDB for Redis include `kvstore_standard`, `kvstore_sharding`, and `kvstore_splitrw`.
EnableEndTime	Long	1640608200000	The timestamp when the blacklist policy started to take effect. Unit: milliseconds.
Name	String	Blacklist-01	The name of the blacklist policy.
EnableStartTime	Long	1640237400000	The timestamp when the blacklist policy expired. Unit: milliseconds.
Id	String	93514c96-ceb8-47d8-8ee3-93b6d98b****	The ID of the blacklist policy.
Metrics	Array of Metrics		The metrics of the instance.
Resource	String	[{"device":"C:"}]	The extended dimension of the instance. For example, `{"device":"C:"}` specifies that the blacklist policy is applied to all C disks of the specified Elastic Compute Service (ECS) instance.
MetricName	String	disk_utilization	The name of the metric.
Instances	Array of String	i-rj99xc6cptkk64ml****	The IDs of instances that belong to the specified cloud service.
ScopeValue	Array of String	["67**","78**"]	The ID of the application group. The value of this parameter is a JSON array. Note This parameter is returned only if the `ScopeType` parameter is set to `GROUP`.

Examples

Sample requests

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

Sample success responses

XML format

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 format

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
}

Error codes

HTTP status code	Error code	Error message	Description
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.

For a list of error codes, see Service error codes.