CreateCompliancePack_配置审计_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

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

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

流控信息

请求速率为10/60(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
config:CreateCompliancePack
Create
CompliancePack
acs:config:*:{#accountId}:compliancepack/*

请求参数

字段名称字段详情
CompliancePackTemplateIdstring

合规包模板 ID。展开详情

示例值:ct-5f26ff4e06a300c4****参考取值来源:
    ListCompliancePackTemplates
    GetCompliancePack
CompliancePackNamestring

合规包名称。

示例值:等保三级预检合规包参考取值来源:
    GetCompliancePack
    ListCompliancePacks
    CreateAggregateCompliancePack
字符长度 <= 100
Descriptionstring

合规包描述。

示例值:等保三级预检合规包字符长度 <= 500
RiskLevelinteger<int32>

合规包风险等级。取值:展开详情

示例值:2枚举值:123取值 <= 3
ConfigRulesarray<object>

合规包中的规则列表。展开详情

TemplateContentstring

用于生成合规包的模板信息。模板内容可以从已有合规包详情 API 中查看,或者参考编写配置化合规包模板进行编写。展开详情

示例值:{ "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" } } ] }字符长度 <= 1024000
ClientTokenstring

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

示例值:1594295238-f9361358-5843-4294-8d30-b5183fac****
DefaultEnableboolean

规则是否支持快速启用。取值:展开详情

示例值: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

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

示例值:test
TagsScopearray<object>

标签范围

ExcludeTagsScopearray<object>

排除的标签范围

Tagarray<object>

资源的标签。展开详情

子级条数 <= 21

请求说明

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

返回参数

字段名称字段详情
CompliancePackIdstring

合规包 ID。

示例值:cp-a8a8626622af0082****
RequestIdstring

请求 ID。

示例值:6EC7AED1-172F-42AE-9C12-295BC2ADB751

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
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.诊断
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.诊断

变更历史

变更时间变更内容概要操作
2025-01-21
新增请求参数Tag
2024-06-19
新增请求参数ExcludeRegionIdsScope
新增请求参数ResourceIdsScope
新增请求参数ExcludeResourceGroupIdsScope
新增请求参数TagsScope
新增请求参数ExcludeTagsScope
2024-01-26
变更请求参数CompliancePackTemplateId
变更请求参数Description
变更请求参数RiskLevel
变更请求参数ConfigRules
变更请求参数RegionIdsScope
变更请求参数ExcludeResourceIdsScope
变更请求参数ResourceGroupIdsScope
变更请求参数TagKeyScope
变更请求参数TagValueScope
2023-12-13
变更请求参数RiskLevel
变更请求参数ConfigRules
新增请求参数TemplateContent
2022-12-15
新增请求参数RegionIdsScope
新增请求参数ExcludeResourceIdsScope
新增请求参数ResourceGroupIdsScope
新增请求参数TagKeyScope
新增请求参数TagValueScope

相关示例

创建合规包
2021-12-20