DescribeMetricRuleBlackList - CloudMonitor - Alibaba Cloud Documentation Center

Queries blacklist policies.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cms:DescribeMetricRuleBlackList	list	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Namespace	string	No	The timestamp when the blacklist policy expired. Unit: milliseconds.	acs_ecs_dashboard
PageNumber	integer	No	The name of the metric.	1
PageSize	integer	No	The categories 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`.	100
Order	integer	No	The HTTP status code. Note The status code 200 indicates that the call was successful.	DESC
Category	string	No	The ID of the blacklist policy.	ecs
Ids	array	No
	string	No	The operation that you want to perform. Set the value to DescribeMetricRuleBlackList.	a9ad2ac2-3ed9-11ed-b878-0242ac12****
Name	string	No	The name of the blacklist policy. This parameter supports fuzzy match.	Blacklist-01
ScopeType	string	No	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.	USER
IsEnable	boolean	No	The status of the blacklist policy. Valid values: true: The blacklist policy is enabled. false: The blacklist policy is disabled.	true
InstanceIds	array	No	The IDs of the instances in the blacklist policy. Valid values of N: 0 to 10.
	string	No	The ID of the instance in the blacklist policy.	i-2ze2d6j5uhg20x47****

Indicates whether the call was successful. Valid values:

true: The call was successful.
false: The call failed.

Response parameters

Parameter	Type	Description	Example
	object	None
Code	string	The categories 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`.	200
Message	string	The error message.	The Request is not authorization.
RequestId	string	The namespace of the cloud service.	D63E76CB-29AA-5B9F-88CE-400A6F28D428
Total	integer	The timestamp when the blacklist policy was created. Unit: milliseconds.	1
Success	boolean	The namespace of the cloud service. For more information about the namespaces of different cloud services, see Appendix 1: Metrics.	true
DescribeMetricRuleBlackList	array<object>	The queried blacklist policies.
	object
EffectiveTime	string	The time range within which the blacklist policy is effective.	00:00-23:59
UpdateTime	string	The timestamp when the blacklist policy was modified. Unit: milliseconds.	1665718373000
CreateTime	string	The timestamp when the blacklist policy was created. Unit: milliseconds.	1665714561000
ScopeType	string	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.	USER
IsEnable	boolean	The status of the blacklist policy. Valid values: true: The blacklist policy is enabled. false: The blacklist policy is disabled.	true
Namespace	string	The namespace of the cloud service.	acs_ecs_dashboard
Category	string	The category of the 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`.	ecs
EnableEndTime	long	The timestamp when the blacklist policy started to take effect. Unit: milliseconds.	1640608200000
Name	string	The name of the blacklist policy.	Blacklist-01
EnableStartTime	long	The timestamp when the blacklist policy expired. Unit: milliseconds.	1640237400000
Id	string	The ID of the blacklist policy.	93514c96-ceb8-47d8-8ee3-93b6d98b****
Metrics	array<object>	The metrics of the instance.
	object
Resource	string	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.	[{"device":"C:"}]
MetricName	string	The metric name.	disk_utilization
Instances	array	The IDs of the instances that belong to the specified cloud service.
	string	The IDs of the instances that belong to the specified cloud service.	i-rj99xc6cptkk64ml****
ScopeValue	array	The IDs of the application groups.
	string	The IDs of the application groups. The value of this parameter is a JSON array. Note This parameter is returned only if the `ScopeType` parameter is set to `GROUP`.	["67**","78**"]

Examples

Sample success responses

JSONformat

{
  "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****\"]"
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	ParameterInvalid	Illegal parameters.	-
403	AccessForbidden	User not authorized to operate on the specified resource.	-
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.
409	ResourceConflict	Concurrent modification of resources.	-
409	ResourceExist	Resources already exist.	-
500	InternalError	The request processing has failed due to some unknown error.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-07-11	The Error code has changed. The request parameters of the API has changed	View Change Details
2022-06-22	Add Operation	View Change Details