文档

UpdateConfigRule - 修改规则

更新时间:

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

接口说明

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

调试

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

授权信息

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

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

请求参数

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

规则 ID。

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

cr-a260626622af0005****
Descriptionstring

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

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

规则参数。

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

规则执行周期。取值:

  • One_Hour:1 小时。
  • Three_Hours:3 小时。
  • Six_Hours:6 小时。
  • Twelve_Hours:12 小时。
  • TwentyFour_Hours(默认值):24 小时。
说明 ConfigRuleTriggerTypes设置为ScheduledNotification时,需要设置该参数。
One_Hour
ResourceTypesScopearray

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

string

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

ACS::ECS::Instance
RiskLevelinteger

规则风险等级。取值:

  • 1:高风险。
  • 2:中风险。
  • 3:低风险。
3
ClientTokenstring

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

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

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

说明 仅适用于规则模板。
cn-hangzhou
ExcludeResourceIdsScopestring

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

说明 仅适用于规则模板。
lb-t4nbowvtbkss7t326****
ConfigRuleTriggerTypesstring

规则触发机制。取值:

  • ConfigurationItemChangeNotification:配置变更。

  • ScheduledNotification:周期执行。

说明 仅自定义规则能修改该参数。
ConfigurationItemChangeNotification
ResourceGroupIdsScopestring

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

说明 仅适用于规则模板。
rg-aekzc7r7rhx****
TagKeyScopestring

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

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

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

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

参数TagKeyScope取多值时的逻辑关系,例如:当参数TagKeyScope取值为ECS,OSS时,如果该参数为AND,则表示规则仅对同时绑定标签ECSOSS的资源生效。取值:

  • AND:与。

  • OR:或。

AND
ConfigRuleNamestring

规则名称。

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

存在所有指定标签

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

返回参数

名称类型描述示例值
object

ConfigRuleIdstring

规则 ID。

cr-a260626622af0005****
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400ExceedMaxRuleCountThe maximum number of rules is exceeded.超过规则上限。
400ConfigRuleNotExistsThe ConfigRule does not exist.此规则不存在。
400ConfigRuleExistsThe ConfigRule already exists.规则名称重复。
404AccountNotExistedYour account does not exist.您的账号不存在。
503ServiceUnavailableThe request has failed due to a temporary failure of the server.服务不可用。

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

变更历史

变更时间变更内容概要操作
暂无变更历史