全部产品
Search

搜索本产品

    配置审计：CreateCompliancePack - 创建合规包

    文档中心

    配置审计：CreateCompliancePack - 创建合规包

    更新时间：Dec 10, 2024

    为当前账号创建合规包。

    接口说明

    合规包是一组规则的集合。新建合规包时，您可以选择合规包模板中的默认规则，也可以选择规则模板和已有规则列表中的规则。 新建合规包后，这些规则默认会执行一次评估，后续将根据规则的触发机制自动触发评估，也可以手动执行评估。

    合规包模板是配置审计根据合规场景定制的一组规则的集合。

    本文将提供一个示例，通过合规包模板ClassifiedProtectionPreCheck（等保三级预检合规包）创建一个合规包。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    CompliancePackTemplateIdstring否

    合规包模板 ID。

    关于如何获取合规包模板 ID，请参见 ListCompliancePackTemplates 。

    		ct-5f26ff4e06a300c4****
    CompliancePackNamestring是

    合规包名称。

    		等保三级预检合规包
    Descriptionstring否

    合规包描述。

    		等保三级预检合规包
    RiskLevelinteger否

    合规包风险等级。取值：

    • 1：高风险。
    • 2（默认值）：中风险。
    • 3：低风险。
    		2
    ConfigRulesarray<object>否

    合规包中的规则列表。

    说明 本参数和TemplateContent必须设置其中一个。
    object否

    合规包中的规则列表。

    ManagedRuleIdentifierstring否

    规则模板标识。配置审计根据规则模板标识自动创建规则，并将该规则加入到当前合规包中。

    说明 ManagedRuleIdentifier和ConfigRuleId二选一，当两个参数都设置时，以ConfigRuleId为准确。
    		eip-bandwidth-limit
    ConfigRuleNamestring否

    规则名称。

    		弹性IP实例带宽满足最低要求
    ConfigRuleParametersarray<object>否

    规则参数信息。

    object否

    规则参数信息。

    ParameterNamestring否

    规则参数名称。

    参数ParameterName和ParameterValue必须同时设置，或同时不设置。如果规则模板存在参数，且无默认值，则您必须设置该参数。

    		bandwidth
    ParameterValuestring否

    规则参数值。

    参数ParameterName和ParameterValue必须同时设置，或同时不设置。如果规则模板存在参数，且无默认值，则您必须设置该参数。

    		10
    ConfigRuleIdstring否

    规则 ID。配置审计将已有规则加入到当前合规包中。

    ManagedRuleIdentifier和ConfigRuleId二选一，当两个参数都设置时，以ConfigRuleId为准确。

    		cr-e918626622af000f****
    Descriptionstring否

    规则描述。

    		弹性公网已绑定到ECS或者NAT实例，非闲置状态，视为“合规”。
    RiskLevelinteger否

    规则风险等级。取值：

    • 1：高风险。
    • 2：中风险。
    • 3：低风险。
    		1
    TemplateContentstring否

    用于生成合规包的模板信息。模板内容可以从已有合规包详情 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" } } ] }
    ClientTokenstring否

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

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

    规则是否支持快速启用。取值：

    • true：合规包快捷启用时会开启该规则。
    • false（默认值）：不启用。
    		false
    RegionIdsScopestring否

    合规包仅对指定地域 ID 中的资源生效。多个地域 ID 之间用半角逗号（,）分隔。

    		cn-hangzhou
    ExcludeRegionIdsScopestring否

    排除的地域范围，多个地域 ID 之间用半角逗号（,）分隔。

    		cn-hangzhou
    ExcludeResourceIdsScopestring否

    合规包对指定资源 ID 无效，即不对该资源执行评估。多个资源 ID 之间用半角逗号（,）分隔。

    		eip-8vbf3x310fn56ijfd****
    ResourceIdsScopestring否

    生效的资源范围，多个地域 ID 之间用半角逗号（,）分隔。

    		eip-8vbf3x310fn56ijfd****
    ResourceGroupIdsScopestring否

    合规包仅对指定资源组 ID 中的资源生效。多个资源组 ID 之间用半角逗号（,）分隔。

    		rg-aekzdibsjjc****
    ExcludeResourceGroupIdsScopestring否

    合规包仅对指定资源组 ID 中的资源不生效。多个资源组 ID 之间用半角逗号（,）分隔。

    		rg-bnczc6r7rml****
    TagKeyScopestring否

    合规包仅对绑定指定标签键的资源生效。

    		ECS
    TagValueScopestring否

    合规包仅对绑定指定标签键值对的资源生效。

    说明 TagValueScope 需结合 TagKeyScope 一起使用。
    		test
    TagsScopearray<object>否

    标签范围

    object否
    TagKeystring否

    资源的标签。

    		key-1
    TagValuestring否

    标签值。

    		value-1
    ExcludeTagsScopearray<object>否

    排除的标签范围

    object否
    TagKeystring否

    标签键。

    		key-2
    TagValuestring否

    标签值。

    		value-2

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

    返回参数

    名称类型描述示例值
    object

    无

    CompliancePackIdstring

    合规包 ID。

    		cp-a8a8626622af0082****
    RequestIdstring

    请求 ID。

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

    示例

    正常返回示例

    JSON格式

    {
  "CompliancePackId": "cp-a8a8626622af0082****",
  "RequestId": "6EC7AED1-172F-42AE-9C12-295BC2ADB751"
}

    错误码

    HTTP status code错误码错误信息描述
    400CompliancePackExceedMaxCountThe maximum number of compliance pack is exceeded.-
    400Invalid.ConfigRules.EmptyYou must specify ConfigRules.-
    400Invalid.ConfigRules.ValueThe specified ConfigRules is invalid.合规包规则中参数输入错误。
    400ConfigRuleExceedMaxRuleCountThe maximum number of config rules is exceeded.-
    400Invalid.CompliancePackName.EmptyYou must specify CompliancePackName.合规包名称不能为空。
    400Invalid.CompliancePackName.ValueThe specified CompliancePackName is invalid.合规包名称格式不符合要求。
    400Invalid.CompliancePackTemplateId.ValueThe specified CompliancePackTemplateId does not exist.合规包模板ID不存在。
    400CompliancePackExistsThe compliance pack already exists.合规包名称重复。
    404AccountNotExistedYour account does not exist.-
    503ServiceUnavailableThe request has failed due to a temporary failure of the server.服务不可用。

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

    变更历史

    变更时间变更内容概要操作
    2023-12-13OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情