修改规则的描述信息、规则入参和风险等级等。
接口说明
本文将提供一个示例,将规则cr-a260626622af0005****
的风险等级修改为3
(低风险)。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
config:UpdateConfigRule | update | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ConfigRuleId | string | 是 | 规则 ID。 关于如何获取规则 ID,请参见 ListConfigRules 。 | cr-a260626622af0005**** |
Description | string | 否 | 规则描述。最多输入 500 个字符。 | 最多可以定义6组标签。如果资源同时具有指定的所有标签,则视为“合规”。 |
InputParameters | object | 否 | 规则参数。 | {"tag1Key":"ECS","tag1Value":"test"} |
MaximumExecutionFrequency | string | 否 | 规则执行周期。取值:
说明
当 ConfigRuleTriggerTypes 设置为ScheduledNotification 时,需要设置该参数。
| One_Hour |
ResourceTypesScope | array | 否 | 规则评估的资源类型。多个资源类型之间用半角逗号(,)分隔。 | |
string | 否 | 规则评估的资源类型。多个资源类型之间用半角逗号(,)分隔。 | ACS::ECS::Instance | |
RiskLevel | integer | 否 | 规则风险等级。取值:
| 3 |
ClientToken | string | 否 | 保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。 | 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 |
ResourceGroupIdsScope | string | 否 | 规则仅对指定资源组 ID 中的资源生效。多个资源组 ID 之间用半角逗号(,)分隔。 说明
仅适用于规则模板。
| rg-aekzc7r7rhx**** |
ExcludeResourceGroupIdsScope | string | 否 | 规则对指定资源组 ID 中的资源无效,即不对该资源组内的资源评估。多个资源组 ID 之间用半角逗号(,)分隔。 | rg-bnczc6r7rml**** |
TagKeyScope | string | 否 | 规则仅对绑定指定标签的资源生效。 说明
仅适用于规则模板,且 TagKeyScope 和TagValueScope 必须同时设置。
| ECS |
TagValueScope | string | 否 | 规则仅对绑定指定标签的资源生效。 说明
仅适用于规则模板,且 TagKeyScope 和TagValueScope 必须同时设置。
| test |
TagKeyLogicScope | string | 否 | 参数
| 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"} |
关于公共请求参数的详情,请参见公共参数。
返回参数
示例
正常返回示例
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. | 服务不可用。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|