文档

ModifyMetricRuleBlackList - 修改报警黑名单策略

更新时间:

调用ModifyMetricRuleBlackList接口修改报警黑名单策略。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
Idstring

报警黑名单策略的 ID。

关于如何获取报警黑名单策略的 ID,请参见 DescribeMetricRuleBlackList

93514c96-ceb8-47d8-8ee3-93b6d98b****
Namestring

报警黑名单策略的名称。

Blacklist-02
Namespacestring

云产品的数据命名空间。

关于云产品的命名空间,请参见云产品监控项

acs_ecs_dashboard
Categorystring

云产品分类。例如:Redis 有kvstore_standard(标准版)、kvstore_sharding(集群版)和kvstore_splitrw(读写分离版)等。

ecs
ScopeTypestring

报警黑名单策略的生效范围。取值:

  • USER:报警黑名单策略仅在当前阿里云账号中生效。

  • GROUP(默认值):报警黑名单策略在指定应用分组中生效,您需要选择指定应用分组。 关于如何获取应用分组 ID,请参见 DescribeMonitorGroups

USER
ScopeValuestring

应用分组 ID 列表。

说明 仅当ScopeTypeGROUP时,需要设置该参数。
["67****","78****"]
EnableStartTimestring

报警黑名单策略生效的开始时间戳。

单位:毫秒。

1640237400000
EnableEndTimestring

报警黑名单策略生效的结束时间戳。

单位:毫秒。

1640608200000
EffectiveTimestring

报警黑名单策略的生效时间范围。是否设置该参数的含义如下:

  • 如果您未设置该参数,则报警黑名单策略永久有效。

  • 如果您已设置该参数,则黑名单策略仅在指定的时间范围内有效。该参数有以下两种格式示例:

    • 03:00-04:59:本地时间凌晨 3 点到凌晨 5 点(不包含 05:00)报警黑名单策略有效。
    • 03:00-04:59 UTC+0700:东 7 区时间凌晨 3 点到凌晨 5 点(不包含 05:00)报警黑名单策略有效。
03:00-04:59
Instancesarray

报警黑名单策略中指定云服务的实例列表。

string

报警黑名单策略中指定云服务的实例列表。

N 的取值范围:1~100。

{"instancceId":"i-bp1ew0zfkjblsuwx****"}
Metricsobject []

实例中的监控指标。

  • 如果您未设置该参数,则报警黑名单策略应用于指定云服务下的所有监控指标。

  • 如果您已设置该参数,则黑名单策略仅应用于当前监控指标。

MetricNamestring

监控指标名称。

N 的取值范围:1~10。

disk_utilization
Resourcestring

实例的扩展维度信息。例如:{"device":"C:"},表示对云服务器 ECS 实例下的所有 C 盘应用黑名单策略。

N 的取值范围:1~10。

{"device":"C:"}

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

返回参数

名称类型描述示例值
object

无。

Codestring

状态码。

说明 200 表示成功。
200
Messagestring

错误信息。

The specified resource is not found.
RequestIdstring

请求 ID。

008773AE-1D86-3231-90F9-1AF7F808F9CE
Successboolean

操作是否成功。取值:

  • true:成功。

  • false:失败。

true
Countstring

成功修改报警黑名单策略的数量。

1

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400ParameterInvalidIllegal parameters.-
403AccessForbiddenUser not authorized to operate on the specified resource.-
404ResourceNotFoundThe specified resource is not found.未找到指定资源。
409ResourceConflictConcurrent modification of resources.-
409ResourceExistResources already exist.-
500InternalErrorThe request processing has failed due to some unknown error.-

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

变更历史

变更时间变更内容概要操作
2022-06-22新增 OpenAPI看变更集