CreateMetricRuleBlackList - Cloud Monitor - Alibaba Cloud Documentation Center

Creates a blacklist policy.

Operation description

Background information

CloudMonitor blocks alert notifications based on the blacklist policies that take effect. To block alert notifications when the value of a metric that belongs to a cloud service reaches the threshold that you specified, add the metric to a blacklist policy.
CloudMonitor allows you to create blacklist policies only based on threshold metrics. You cannot create blacklist policies based on system events. For more information about the cloud services and the thresholds of the metrics that are supported by CloudMonitor, see Appendix 1: Metrics.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cms:CreateMetricRuleBlackList

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The name of the blacklist policy.	Blacklist-01
Namespace	string	Yes	The namespace of the cloud service. For more information about the namespaces of different cloud services, see Appendix 1: Metrics.	acs_ecs_dashboard
Category	string	Yes	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
ScopeType	string	No	The effective scope of the blacklist policy. Valid values: USER (default): The blacklist policy takes effect only for the current Alibaba Cloud account. GROUP: The blacklist policy takes effect only for the specified application group. For information about how to query the IDs of application groups, see DescribeMonitorGroups.	USER
ScopeValue	string	No	The ID of the application group. The value of this parameter is a JSON array. Note This parameter must be specified when `ScopeType` is set to `GROUP`.	["67**","78**"]
EnableStartTime	string	No	The timestamp when the blacklist policy starts to take effect. Unit: milliseconds.	1640237400000
EnableEndTime	string	No	The timestamp when the blacklist policy expires. Unit: milliseconds.	1640608200000
EffectiveTime	string	No	The time range within which the blacklist policy is effective. If you do not configure this parameter, the blacklist policy is permanently effective. If you configure this parameter, the blacklist policy is effective only within the specified time range. Examples: `03:00-04:59`: The blacklist policy is effective from 03:00 to 05:00 local time. 05:00 local time is excluded. `03:00-04:59 UTC+0700`: The blacklist policy is effective from 03:00 to 05:00 (UTC+7). 05:00 (UTC+7) is excluded.	03:00-04:59
Instances	array	Yes	The IDs of the instances that belong to the specified cloud service.
	string	No	The IDs of the instances that belong to the specified cloud service. Valid values of N: 1 to 100.	{"instanceId":"i-bp1ew0zfkjblsuwx****"}
Metrics	array<object>	No	The metrics of the instance. If you do not configure this parameter, the blacklist policy applies to all metrics of the specified cloud service. If you configure this parameter, the blacklist policy applies only to the current metric.
	object	No	None
MetricName	string	Yes	The metric name. Valid values of N: 1 to 10.	disk_utilization
Resource	string	No	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. Valid values of N: 1 to 10.	{"device":"C:"}

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

Response elements

Element	Type	Description	Example
	object	None
Code	string	The status code. Note The status code 200 indicates that the request was successful.	200
Message	string	The error message.	The request has failed due to a temporary failure of the server.
RequestId	string	The request ID.	5C637FA3-3959-3352-8BE6-78CE2ED2D33D
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Id	string	The ID of the blacklist policy.	93514c96-ceb8-47d8-8ee3-93b6d98b****

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "The request has failed due to a temporary failure of the server.",
  "RequestId": "5C637FA3-3959-3352-8BE6-78CE2ED2D33D",
  "Success": true,
  "Id": "93514c96-ceb8-47d8-8ee3-93b6d98b****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ParameterInvalid	Illegal parameters.
500	InternalError	The request processing has failed due to some unknown error.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.