调用CreateMetricRuleBlackList创建报警黑名单策略

调用CreateMetricRuleBlackList接口创建报警黑名单策略。

接口说明

背景信息

报警黑名单是指云监控根据报警黑名单策略对报警通知进行屏蔽。当阈值报警规则中某个云服务的某个实例中的某个指标无需发送报警通知时，您可以为其设置报警黑名单策略，对报警通知进行屏蔽。
目前云监控仅支持为阈值指标设置报警黑名单策略，不支持系统事件。关于云监控支持的云服务和阈值指标，请参见云服务监控项。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
cms:CreateMetricRuleBlackList	create	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
Name	string	是	报警黑名单策略的名称。	Blacklist-01
Namespace	string	是	云服务的数据命名空间。关于云服务的命名空间，请参见云服务监控项。	acs_ecs_dashboard
Category	string	是	云服务的类型分类。例如：Redis 有`kvstore_standard`（标准版）、`kvstore_sharding`（集群版）和`kvstore_splitrw`（读写分离版）等。	ecs
ScopeType	string	否	报警黑名单策略的生效范围。取值： USER（默认值）：报警黑名单策略仅在当前阿里云账号中生效。 GROUP：报警黑名单策略在指定应用分组中生效，您需要选择指定应用分组。关于如何获取应用分组 ID，请参见 DescribeMonitorGroups 。	USER
ScopeValue	string	否	应用分组 ID 列表。格式为 JSON Array。说明仅当`ScopeType`为`GROUP`时，需要设置该参数。	["67**","78**"]
EnableStartTime	string	否	报警黑名单策略生效的开始时间戳。单位：毫秒。	1640237400000
EnableEndTime	string	否	报警黑名单策略生效的结束时间戳。单位：毫秒。	1640608200000
EffectiveTime	string	否	报警黑名单策略的生效时间范围。如果您未设置该参数，则报警黑名单策略永久有效。如果您已设置该参数，则黑名单策略仅在指定的时间范围内有效。该参数有以下两种格式示例： `03:00-04:59`：本地时间凌晨 3 点到凌 5 点（不包含 05:00）报警黑名单策略有效。 `03:00-04:59 UTC+0700`：东 7 区时间凌晨 3 点到凌晨 5 点（不包含 05:00）报警黑名单策略有效。	03:00-04:59
Instances	array	是	报警黑名单策略中指定云服务的实例列表。
	string	是	报警黑名单策略中指定云服务的实例列表。 N 的取值范围：1~100。	{"instanceId":"i-bp1ew0zfkjblsuwx****"}
Metrics	array<object>	否	实例中的监控指标。如果您未设置该参数，则报警黑名单策略应用于指定云服务下的所有监控指标。如果您已设置该参数，则黑名单策略仅应用于当前监控指标。
	object	否	无。
MetricName	string	是	监控指标名称。 N 的取值范围：1~10。	disk_utilization
Resource	string	否	实例的扩展维度信息。例如：`{"device":"C:"}`，表示对云服务器 ECS 实例下的所有 C 盘应用黑名单策略。 N 的取值范围：1~10。	{"device":"C:"}

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

返回参数

名称	类型	描述	示例值
	object	无。
Code	string	状态码。说明 200 表示成功。	200
Message	string	错误信息。	The request has failed due to a temporary failure of the server.
RequestId	string	请求 ID。	5C637FA3-3959-3352-8BE6-78CE2ED2D33D
Success	boolean	操作是否成功。取值： true：成功。 false：失败。	true
Id	string	报警黑名单策略的 ID。	93514c96-ceb8-47d8-8ee3-93b6d98b****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	ParameterInvalid	Illegal parameters.	-
403	AccessForbidden	User not authorized to operate on the specified resource.	-
404	ResourceNotFound	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.	-

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

变更历史

变更时间	变更内容概要	操作
2023-04-23	OpenAPI 错误码发生变更	查看变更详情
2022-06-22	新增 OpenAPI	查看变更详情