UpdateConfigRule - 修改规则

修改规则的描述信息、规则入参和风险等级等。

接口说明

本文将提供一个示例,将规则cr-a260626622af0005****的风险等级修改为3(低风险)。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

config:UpdateConfigRule

update

*Rule

acs:config:*:{#accountId}:rule/{#ConfigRuleId}

请求参数

名称

类型

必填

描述

示例值

ConfigRuleId

string

规则 ID。

关于如何获取规则 ID,请参见 ListConfigRules

cr-a260626622af0005****

Description

string

规则描述。最多输入 500 个字符。

最多可以定义6组标签。如果资源同时具有指定的所有标签,则视为“合规”。

InputParameters

object

规则参数。

{"tag1Key":"ECS","tag1Value":"test"}

MaximumExecutionFrequency

string

规则执行周期。取值:

  • One_Hour:1 小时。

  • Three_Hours:3 小时。

  • Six_Hours:6 小时。

  • Twelve_Hours:12 小时。

  • TwentyFour_Hours(默认值):24 小时。

说明

ConfigRuleTriggerTypes设置为ScheduledNotification时,需要设置该参数。

One_Hour

ResourceTypesScope

array

规则评估的资源类型。多个资源类型之间用半角逗号(,)分隔。

ACS::ECS::Instance

string

规则评估的资源类型。多个资源类型之间用半角逗号(,)分隔。

ACS::ECS::Instance

RiskLevel

integer

规则风险等级。取值:

  • 1:高风险。

  • 2:中风险。

  • 3:低风险。

3

ClientToken

string

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持 ASCII 字符,且不能超过 64 个字符。

1594295238-f9361358-5843-4294-8d30-b5183fac****

RegionIdsScope

string

规则仅对指定地域 ID 中的资源生效。多个地域 ID 之间用半角逗号(,)分隔。

说明

仅适用于规则模板。

cn-hangzhou

ExcludeRegionIdsScope

string

规则对指定地域内资源无效,即不对该地域内资源执行评估。多个地域 ID 之间用半角逗号(,)分隔。

cn-shanghai

ExcludeResourceIdsScope

string

规则对指定资源 ID 无效,即不对该资源执行评估。多个资源 ID 之间用半角逗号(,)分隔。

说明

仅适用于规则模板。

lb-t4nbowvtbkss7t326****

ResourceIdsScope

string

规则对指定资源 ID 生效。多个资源 ID 之间用半角逗号(,)分隔。

lb-5cmbowstbkss9ta03****

ConfigRuleTriggerTypes

string

规则触发机制。取值:

  • ConfigurationItemChangeNotification:配置变更。

  • ScheduledNotification:周期执行。

说明

仅自定义规则能修改该参数。

ConfigurationItemChangeNotification

ResourceGroupIdsScope

string

规则仅对指定资源组 ID 中的资源生效。多个资源组 ID 之间用半角逗号(,)分隔。

说明

仅适用于规则模板。

rg-aekzc7r7rhx****

ExcludeResourceGroupIdsScope

string

规则对指定资源组 ID 中的资源无效,即不对该资源组内的资源评估。多个资源组 ID 之间用半角逗号(,)分隔。

rg-bnczc6r7rml****

TagKeyScope deprecated

string

已废弃,请使用 TagsScope 字段。

规则仅对绑定指定标签的资源生效。

说明

仅适用于规则模板,且TagKeyScopeTagValueScope必须同时设置。

ECS

TagValueScope deprecated

string

已废弃,请使用 TagsScope 字段。

规则仅对绑定指定标签的资源生效。

说明

仅适用于规则模板,且TagKeyScopeTagValueScope必须同时设置。

test

TagKeyLogicScope

string

参数TagsScope 取多值时的逻辑关系,例如:当参数TagsScope取值为"TagsScope.1.TagKey":"a","TagsScope.1.TagValue":"a","TagsScope.2.TagKey":"b","TagsScope.2.TagValue":"b"时,如果该参数为AND,则表示规则仅对同时绑定标签a:ab:b的资源生效。不填写取默认逻辑OR

也可以用于已废弃字段TagKeyScope字段(不推荐),例如:当参数TagKeyScope取值为ECS,OSS时,如果该参数为AND,则表示规则仅对同时绑定标签ECSOSS的资源生效。

取值:

  • AND:与。

  • OR:或。

枚举值:

  • OR :

    OR

  • AND :

    AND

AND

TagsScope

array<object>

标签范围

object

TagKey

string

标签键。

key-1

TagValue

string

标签值。

value-1

ExcludeTagsScope

array<object>

排除的标签范围

object

TagKey

string

标签键。

key-2

TagValue

string

标签值。

value-2

ConfigRuleName

string

规则名称。

关于如何获取规则名称,请参见 ListAggregateConfigRules

存在所有指定标签

ExtendContent

string

选填,扩展内容,与 24h 周期触发配合使用,用于设置触发时间。

{"fixedHour":"12"}

Tag deprecated

array<object>

资源的标签。该入参已弃用,请忽略,传入不会生效。

最多支持绑定 20 个标签。

object

资源的标签。

最多支持绑定 20 个标签。

Key

string

标签键。

key-1

Value

string

标签值

value-1

ResourceNameScope

string

规则仅对指定资源名称的资源生效。

i-xxx

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

返回参数

名称

类型

描述

示例值

object

ConfigRuleId

string

规则 ID。

cr-a260626622af0005****

RequestId

string

请求 ID。

6EC7AED1-172F-42AE-9C12-295BC2ADB751

示例

正常返回示例

JSON格式

{
  "ConfigRuleId": "cr-a260626622af0005****",
  "RequestId": "6EC7AED1-172F-42AE-9C12-295BC2ADB751"
}

错误码

HTTP status code

错误码

错误信息

描述

400 ExceedMaxRuleCount The maximum number of rules is exceeded.
400 ConfigRuleNotExists The ConfigRule does not exist. 此规则不存在。
400 ConfigRuleExists The ConfigRule already exists.
404 AccountNotExisted Your account does not exist.
503 ServiceUnavailable The request has failed due to a temporary failure of the server. 服务不可用。

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

变更历史

更多信息,参考变更详情