为当前账号创建合规包。
接口说明
合规包是一组规则的集合。新建合规包时,您可以选择合规包模板中的默认规则,也可以选择规则模板和已有规则列表中的规则。 新建合规包后,这些规则默认会执行一次评估,后续将根据规则的触发机制自动触发评估,也可以手动执行评估。
合规包模板是配置审计根据合规场景定制的一组规则的集合。
本文将提供一个示例,通过合规包模板ClassifiedProtectionPreCheck(等保三级预检合规包)创建一个合规包。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
config:CreateCompliancePack |
create |
*CompliancePack
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| CompliancePackTemplateId |
string |
否 |
合规包模板 ID。 关于如何获取合规包模板 ID,请参见 ListCompliancePackTemplates 。 |
ct-5f26ff4e06a300c4**** |
| CompliancePackName |
string |
是 |
合规包名称。 |
等保三级预检合规包 |
| Description |
string |
否 |
合规包描述。 |
等保三级预检合规包 |
| RiskLevel |
integer |
否 |
合规包风险等级。取值:
|
2 |
| ConfigRules |
array<object> |
否 |
合规包中的规则列表。 说明
本参数和 |
|
|
array<object> |
否 |
合规包中的规则列表。 |
||
| ManagedRuleIdentifier |
string |
否 |
规则模板标识。配置审计根据规则模板标识自动创建规则,并将该规则加入到当前合规包中。 说明
|
eip-bandwidth-limit |
| ConfigRuleName |
string |
否 |
规则名称。 |
弹性IP实例带宽满足最低要求 |
| ConfigRuleParameters |
array<object> |
否 |
规则参数信息。 |
|
|
object |
否 |
规则参数信息。 |
||
| ParameterName |
string |
否 |
规则参数名称。 参数 |
bandwidth |
| ParameterValue |
string |
否 |
规则参数值。 参数 |
10 |
| ConfigRuleId |
string |
否 |
规则 ID。配置审计将已有规则加入到当前合规包中。
|
cr-e918626622af000f**** |
| Description |
string |
否 |
规则描述。 |
弹性公网已绑定到ECS或者NAT实例,非闲置状态,视为“合规”。 |
| RiskLevel |
integer |
否 |
规则风险等级。取值:
|
1 |
| TemplateContent |
string |
否 |
用于生成合规包的模板信息。模板内容可以从已有合规包详情 API 中查看,或者参考编写配置化合规包模板进行编写。 说明
本参数和 ConfigRules 必须设置其中一个。 |
{ "configRuleTemplates": [ { "configRuleName": "自定义条件规则示例", "scope": { "complianceResourceTypes": [ "ACS::ECS::Instance" ] }, "description": "", "source": { "owner": "CUSTOM_CONFIGURATION", "identifier": "acs-config-configuration", "sourceDetails": [ { "messageType": "ScheduledNotification", "maximumExecutionFrequency": "Twelve_Hours" }, { "messageType": "ConfigurationItemChangeNotification" } ], "conditions": "{\"ComplianceConditions\":\"{\\\"operator\\\":\\\"and\\\",\\\"children\\\":[{\\\"operator\\\":\\\"GreaterOrEquals\\\",\\\"featurePath\\\":\\\"$.Cpu\\\",\\\"featureSource\\\":\\\"CONFIGURATION\\\",\\\"desired\\\":\\\"2\\\"}]}\"}" }, "inputParameters": {} }, { "configRuleName": "OSS存储空间Referer在指定的防盗链白名单中", "scope": { "complianceResourceTypes": [ "ACS::OSS::Bucket" ] }, "description": "OSS存储空间开启防盗链并且Referer在指定白名单中,视为“合规”。", "source": { "owner": "ALIYUN", "identifier": "oss-bucket-referer-limit", "sourceDetails": [ { "messageType": "ConfigurationItemChangeNotification" } ] }, "inputParameters": { "allowEmptyReferer": "true", "allowReferers": "http://www.aliyun.com" } } ] } |
| ClientToken |
string |
否 |
保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。 |
1594295238-f9361358-5843-4294-8d30-b5183fac**** |
| DefaultEnable |
boolean |
否 |
规则是否支持快速启用。取值:
|
false |
| RegionIdsScope |
string |
否 |
合规包仅对指定地域 ID 中的资源生效。多个地域 ID 之间用半角逗号(,)分隔。 |
cn-hangzhou |
| ExcludeRegionIdsScope |
string |
否 |
排除的地域范围,多个地域 ID 之间用半角逗号(,)分隔。 |
cn-hangzhou |
| ExcludeResourceIdsScope |
string |
否 |
合规包对指定资源 ID 无效,即不对该资源执行评估。多个资源 ID 之间用半角逗号(,)分隔。 |
eip-8vbf3x310fn56ijfd**** |
| ResourceIdsScope |
string |
否 |
生效的资源范围,多个地域 ID 之间用半角逗号(,)分隔。 |
eip-8vbf3x310fn56ijfd**** |
| ResourceGroupIdsScope |
string |
否 |
合规包仅对指定资源组 ID 中的资源生效。多个资源组 ID 之间用半角逗号(,)分隔。 |
rg-aekzdibsjjc**** |
| ExcludeResourceGroupIdsScope |
string |
否 |
合规包仅对指定资源组 ID 中的资源不生效。多个资源组 ID 之间用半角逗号(,)分隔。 |
rg-bnczc6r7rml**** |
| TagKeyScope |
string |
否 |
合规包仅对绑定指定标签键的资源生效。 |
ECS |
| TagValueScope |
string |
否 |
合规包仅对绑定指定标签键值对的资源生效。 说明
TagValueScope 需结合 TagKeyScope 一起使用。 |
test |
| TagsScope |
array<object> |
否 |
标签范围 |
|
|
object |
否 |
|||
| TagKey |
string |
否 |
资源的标签。 |
key-1 |
| TagValue |
string |
否 |
标签值。 |
value-1 |
| ExcludeTagsScope |
array<object> |
否 |
排除的标签范围 |
|
|
object |
否 |
排除的标签范围 |
||
| TagKey |
string |
否 |
标签键。 |
key-2 |
| TagValue |
string |
否 |
标签值。 |
value-2 |
| Tag |
array<object> |
否 |
资源的标签。 最多支持绑定 20 个标签。 |
|
|
object |
否 |
资源的标签。 最多支持绑定 20 个标签。 |
||
| Key |
string |
否 |
资源的标签键。 最多支持绑定 20 个标签键。 |
key-1 |
| Value |
string |
否 |
资源的标签值。 最多支持绑定 20 个标签值。 |
value-1 |
关于公共请求参数的详情,请参见公共参数。
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
无 |
||
| CompliancePackId |
string |
合规包 ID。 |
cp-a8a8626622af0082**** |
| RequestId |
string |
请求 ID。 |
6EC7AED1-172F-42AE-9C12-295BC2ADB751 |
示例
正常返回示例
JSON格式
{
"CompliancePackId": "cp-a8a8626622af0082****",
"RequestId": "6EC7AED1-172F-42AE-9C12-295BC2ADB751"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | CompliancePackExceedMaxCount | The maximum number of compliance pack is exceeded. | |
| 400 | Invalid.ConfigRules.Empty | You must specify ConfigRules. | |
| 400 | Invalid.ConfigRules.Value | The specified ConfigRules is invalid. | 合规包规则中参数输入错误。 |
| 400 | ConfigRuleExceedMaxRuleCount | The maximum number of config rules is exceeded. | |
| 400 | Invalid.CompliancePackName.Empty | You must specify CompliancePackName. | 合规包名称不能为空。 |
| 400 | Invalid.CompliancePackName.Value | The specified CompliancePackName is invalid. | 合规包名称格式不符合要求。 |
| 400 | Invalid.CompliancePackTemplateId.Value | The specified CompliancePackTemplateId does not exist. | 合规包模板ID不存在。 |
| 400 | CompliancePackExists | The compliance pack already exists. | 合规包名称重复。 |
| 404 | AccountNotExisted | Your account does not exist. | |
| 503 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | 服务不可用。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。