接口说明
使用限制
每个管理账号和委派管理员账号最多可以创建 200 条规则。
背景信息
配置审计支持通过以下方法创建规则:
-
基于模板创建规则
规则模板是配置审计已在函数计算中构建的规则函数,您可以通过规则模板快速创建规则。关于规则的更多信息,请参见规则的定义及运行原理。
-
基于函数计算创建规则
自定义函数规则是配置审计通过函数计算服务的函数来承载规则代码的自定义规则。当配置审计预置的规则模板不能满足检测资源合规性的需求时,您可以通过编写函数代码,完成复杂场景的合规检测。关于自定义函数规则的更多信息,请参见自定义函数规则定义和运行原理。
使用说明
本文将提供一个示例,通过规则模板“存在所有指定标签”为账号组ca-a4e5626622af0079****
创建一条规则。返回结果显示规则创建成功,规则 ID 为cr-4e3d626622af0080****
。
流控信息
请求参数
字段名称 | 字段详情 |
---|---|
ConfigRuleNamestring | 规则名称。 示例值:存在所有指定标签参考取值来源: GetConfigRule CreateConfigRule ListConfigRules |
Descriptionstring | 规则描述。 示例值:最多可以定义6组标签。如果资源同时具有指定的所有标签,则视为“合规”。 |
InputParametersobject | 规则参数。 示例值:{"tag1Key":"ECS","tag1Value":"test"} |
ConfigRuleTriggerTypesstring | 规则触发机制。取值:展开详情 示例值:ConfigurationItemChangeNotification参考取值来源: CreateConfigRule GetAggregateConfigRule ListAggregateConfigRuleEvaluationResults |
MaximumExecutionFrequencystring | 规则执行周期。取值:展开详情 示例值:One_Hour枚举值:One_HourThree_HoursSix_HoursTwelve_HoursTwentyFour_Hours |
ResourceTypesScopearray<string> | 规则评估的资源类型。多个资源类型之间用半角逗号(,)分隔。 示例值:ACS::ECS::Instance |
RiskLevelinteger<int32> | 规则风险等级。取值:展开详情 示例值:1枚举值:123 |
ClientTokenstring | 保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。 示例值:1594295238-f9361358-5843-4294-8d30-b5183fac**** |
AggregatorIdstring | 账号组 ID。展开详情 示例值:ca-a4e5626622af0079****参考取值来源: UpdateAggregator ListAggregators CreateAggregator |
RegionIdsScopestring | 规则仅对指定地域 ID 中的资源生效。多个地域 ID 之间用半角逗号(,)分隔。 示例值:cn-hangzhou |
ExcludeRegionIdsScopestring | 规则对指定地域内资源无效,即不对该地域内资源执行评估。多个地域 ID 之间用半角逗号(,)分隔。 示例值:cn-shanghai |
ResourceIdsScopestring | 规则对指定资源 ID 生效。多个资源 ID 之间用半角逗号(,)分隔。 示例值:lb-5cmbowstbkss9ta03**** |
ExcludeResourceIdsScopestring | 规则对指定资源 ID 无效,即不对该资源执行评估。多个资源 ID 之间用半角逗号(,)分隔。 示例值:lb-t4nbowvtbkss7t326**** |
ResourceGroupIdsScopestring | 规则仅对指定资源组 ID 中的资源生效。多个资源组 ID 之间用半角逗号(,)分隔。 示例值:rg-aekzc7r7rhx**** |
ExcludeResourceGroupIdsScopestring | 规则对指定资源组 ID 中的资源无效,即不对该资源组内的资源评估。多个资源组 ID 之间用半角逗号(,)分隔。 示例值:rg-bnczc6r7rml**** |
deprecatedTagKeyScopestring | 已废弃,请使用 示例值:ECS |
deprecatedTagValueScopestring | 已废弃,请使用 示例值:test |
TagKeyLogicScopestring | 参数 示例值:AND枚举值:ORAND |
TagsScopearray<object> | 标签范围 |
ExcludeTagsScopearray<object> | 排除的标签范围 |
SourceOwnerstring | 规则类型。取值:展开详情 示例值:ALIYUN枚举值:ALIYUNCUSTOM_FCCUSTOM_CONFIGURATION |
SourceIdentifierstring | 规则标识符。展开详情 示例值:required-tags |
FolderIdsScopestring | 规则仅对指定资源目录 ID 中成员账号内的资源生效。多个资源目录 ID 之间用半角逗号(,)分隔。展开详情 示例值:fd-ZtHsRH**** |
ExcludeFolderIdsScopestring | 规则对指定资源目录 ID 中成员账号内的资源无效,即不对该资源目录 ID 中成员账号内的资源执行评估。多个资源目录 ID 之间用半角逗号(,)分隔。展开详情 示例值:fd-pWmkqZ**** |
ExcludeAccountIdsScopestring | 规则对指定成员账号内的资源无效,即不对该账号内的资源执行评估。多个成员账号 ID 之间用半角逗号(,)分隔。展开详情 示例值:120886317861**** |
AccountIdsScopestring | 规则仅对指定成员账号内的资源生效。多个成员账号 ID 之间用半角逗号(,)分隔。展开详情 示例值:115748125982**** |
ExtendContentstring | 扩展内容,暂时仅用于配合 24 小时周期触发设置触发时间。 示例值:{"fixedHour":"12"} |
Tagarray<object> | 创建出的规则的标签 子级条数 <= 21 |
ResourceNameScopestring | 规则仅对指定资源名称的资源生效。 示例值:i-xxx |
返回参数
字段名称 | 字段详情 |
---|---|
ConfigRuleIdstring | 规则 ID。 示例值:cr-4e3d626622af0080**** |
RequestIdstring | 请求 ID。 示例值:5895065A-196C-4254-8AD8-14EFC31EEF50 |