Modify a blacklist policy by calling ModifyMetricRuleBlackList - Cloud Monitor - Alibaba Cloud - Cloud Monitor

Modifies an alert blacklist policy.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Id	string	Yes	The ID of the alert blacklist policy. For information about how to obtain the ID of an alert blacklist policy, see DescribeMetricRuleBlackList.	93514c96-ceb8-47d8-8ee3-93b6d98b****
Name	string	Yes	The name of the alert blacklist policy.	Blacklist-02
Namespace	string	Yes	The namespace of the Alibaba Cloud service. For information about the namespaces of Alibaba Cloud services, see Cloud service monitoring metrics.	acs_ecs_dashboard
Category	string	Yes	The category of the Alibaba Cloud service. For example, ApsaraDB for Redis has `kvstore_standard` (Standard Edition), `kvstore_sharding` (Cluster Edition), and `kvstore_splitrw` (read/write splitting Edition).	ecs
ScopeType	string	No	The effective scope of the alert blacklist policy. Valid values: USER: The alert blacklist policy takes effect only within the current Alibaba Cloud account. GROUP (default): The alert blacklist policy takes effect in the specified application group. You must specify an application group. For information about how to obtain the application group ID, see DescribeMonitorGroups.	USER
ScopeValue	string	No	The list of application group IDs. Note This parameter is required only when `ScopeType` is set to `GROUP`.	["67**","78**"]
EnableStartTime	string	No	The start timestamp from which the alert blacklist policy takes effect. Unit: milliseconds.	1640237400000
EnableEndTime	string	No	The end timestamp until which the alert blacklist policy takes effect. Unit: milliseconds.	1640608200000
EffectiveTime	string	No	The effective period of the alert blacklist policy. The implications of whether this parameter is set are as follows: If you do not set this parameter, the alert blacklist policy is permanently effective. If you set this parameter, the alert blacklist policy is effective only within the specified time range. The following two format examples are supported: `03:00-04:59`: The alert blacklist policy is effective from 03:00 to 05:00 (exclusive) in local time. `03:00-04:59 UTC+0700`: The alert blacklist policy is effective from 03:00 to 05:00 (exclusive) in UTC+7.	03:00-04:59
Instances	array	Yes	The list of instances of the specified Alibaba Cloud service in the alert blacklist policy.
	string	No	The list of instances of the specified Alibaba Cloud service in the alert blacklist policy. Valid values of N: 1 to 100.	{"instanceId":"i-bp1ew0zfkjblsuwx****"}
Metrics	array<object>	No	The monitoring metrics of the instances. If you do not set this parameter, the alert blacklist policy applies to all monitoring metrics of the specified Alibaba Cloud service. If you set this parameter, the alert blacklist policy applies only to the specified monitoring metrics.
	object	No	None.
MetricName	string	Yes	The monitoring metrics name. Valid values of N: 1 to 10.	disk_utilization
Resource	string	No	The extension dimension information of the instance. For example, `{"device":"C:"}` indicates that the alert blacklist policy applies to all C drives of the 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 HTTP status code. Note A value of 200 indicates success.	200
Message	string	The error message.	The specified resource is not found.
RequestId	string	The request ID.	008773AE-1D86-3231-90F9-1AF7F808F9CE
Success	boolean	Indicates whether the operation was successful. Valid values: true: The operation was successful. false: The operation failed.	true
Count	string	The number of alert blacklist policies that were successfully modified.	1

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "The specified resource is not found.",
  "RequestId": "008773AE-1D86-3231-90F9-1AF7F808F9CE",
  "Success": true,
  "Count": "1"
}

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.