文档

API概览

更新时间:
本产品(配置审计/2020-09-07)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

账号组

API标题API概述
CreateAggregator创建账号组资源目录中的管理账号或委派管理员账号可以创建账号组,在账号组中集中地管理多个成员的资源、合规包和规则。
UpdateAggregator更新账号组资源目录中的管理账号或委派管理员账号可以修改账号组的名称和描述,也可以添加或移除成员。
DeleteAggregators删除账号组资源目录中的管理账号或委派管理员账号可以删除账号组。
ListAggregators查询账号组列表查询当前管理账号或委派管理员账号下的所有账号组列表。
GetAggregator查询账号组详情查询账号组的名称、创建时间、成员和账号组类型等。

资源

API标题API概述
单账号单账号
ListDiscoveredResources获取资源列表信息获取当前账号下跨地域聚合的资源列表信息。
GetDiscoveredResource获取指定资源的资源详情获取指定资源的资源详情。
ListResourceRelations查询指定资源的相关资源列表查询指定资源的相关资源列表。
GetResourceConfigurationTimeline查询资源配置时间线查询指定资源的配置时间线。配置审计记录资源的每一次配置变更和资源关系变更,并整理为配置时间线。您开通配置审计服务后,配置审计开始记录资源的配置变更和资源关系变更历史,并默认保存10年。
GetResourceComplianceTimeline查询资源合规时间线查询指定资源的合规时间线。合规时间线是资源的一组合规评估记录,包括合规时间线上的点和合规时间线的内容。
ListResourcesByAdvancedSearch应用高级搜索查询资源列表通过SQL的Select语句根据资源属性中的字段精确搜索资源。
CreateAdvancedSearchFile创建资源高级搜索下载文件为当前账号创建资源高级搜索下载文件。
GetAdvancedSearchFile查询资源高级搜索下载文件查询当前账号下最近一次生成的资源高级搜索下载文件(即获取下载文件地址)。
GenerateResourceInventory生成全局资源下载清单生成全局资源下载清单。
GetResourceInventory获取全局资源下载清单信息获取当前账号最近一次生成的全局资源下载清单信息。
GetDiscoveredResourceCountsGroupByRegion从地域维度查询资源的统计结果从地域维度查询资源的统计结果。
GetDiscoveredResourceCountsGroupByResourceType从资源类型维度查询资源的统计结果从资源类型维度查询资源的统计结果。
GetResourceComplianceGroupByResourceType查询指定规则的按资源类型进行分组的评估结果查询规则对资源的评估结果,评估结果按资源类型进行分组展示。
GetResourceComplianceGroupByRegion获取指定规则的按资源所属地域进行分组的评估结果查询规则对资源的评估结果,评估结果按资源所属地域进行分组展示。
多账号多账号
ListAggregateDiscoveredResources获取账号组内资源列表获取指定账号组内所有成员跨地域聚合的资源列表信息。
GetAggregateDiscoveredResource获取账号组内指定资源的资源详情获取账号组内指定资源的资源详情。
ListAggregateResourceRelations查询账号组内指定资源的相关资源列表查询账号组内指定资源的相关资源列表。
GetAggregateResourceConfigurationTimeline查询账号组资源配置时间线查询指定账号组内指定资源的配置时间线。配置审计记录资源的每一次配置变更和资源关系变更,并整理为配置时间线。您开通配置审计服务后,配置审计开始记录资源的配置变更和资源关系变更历史,并默认保存10年。
GetAggregateResourceComplianceTimeline查询账号组资源合规时间线查询指定账号组内指定资源的合规时间线。合规时间线是资源的一组合规评估记录,包括合规时间线上的点和合规时间线的内容。
ListAggregateResourcesByAdvancedSearch应用高级搜索查询账号组内资源列表通过SQL的Select语句根据资源属性中的字段精确搜索指定账号组内的资源。
CreateAggregateAdvancedSearchFile为目标账号组创建资源高级搜索下载文件为目标账号组创建资源高级搜索下载文件。
GetAggregateAdvancedSearchFile查询账号组内资源高级搜索下载文件查询指定账号组下最近一次生成的资源高级搜索下载文件。
GenerateAggregateResourceInventory生成账号组内全局资源下载清单生成指定的账号组内全局资源下载清单。
GetAggregateResourceInventory查询账号组的全局资源下载清单信息获取指定的账号组内最近一次生成的全局资源下载清单信息。
GetAggregateResourceCountsGroupByRegion从地域维度查询指定账号组内资源的统计结果从地域维度查询指定账号组内资源的统计结果。
GetAggregateResourceCountsGroupByResourceType从资源类型维度查询指定账号组内资源的统计结果从资源类型维度查询指定账号组内资源的统计结果。
GetAggregateResourceComplianceGroupByRegion查询指定账号组内规则的按资源所属地域进行分组的评估结果查询指定账号组内规则对资源的评估结果,评估结果按资源所属地域进行分组展示。
GetAggregateResourceComplianceGroupByResourceType获取指定账号组规则的按资源类型进行分组的评估结果查询指定账号组内规则对资源的评估结果,评估结果按资源类型进行分组展示。
GetSupportedResourceRelationConfig查询指定资源类型支持的资源关系查询指定资源类型支持的资源关系。
ListSupportedProducts查询配置审计支持的云产品列表查询配置审计服务支持的云产品和资源类型列表。

规则

API标题API概述
单账号单账号
CreateConfigRule创建规则基于模板创建规则或基于函数计算创建自定义规则,通过规则检测资源的合规性。新建规则后,规则会自动执行一次评估,后续配置审计将根据规则的触发机制自动触发评估,您也可以手动执行评估。
UpdateConfigRule修改规则修改规则的描述信息、规则入参和风险等级等。
ListConfigRules查询规则列表查询规则列表中的所有规则。
GetConfigRule查询规则详情查询指定规则详情。
ListConfigRuleEvaluationResults查询规则评估结果从规则维度查询规则对资源的评估结果。
ListResourceEvaluationResults查询资源评估结果从资源维度查询规则对资源的评估结果。
DeleteConfigRules删除规则删除指定规则。删除规则后,其配置信息不再保留。
DeactiveConfigRules停用规则停用规则后,不再对资源进行评估,仍显示停用前的合规评估结果。
ActiveConfigRules启用规则启用规则后,规则继续按照触发机制自动对资源进行评估。
StartConfigRuleEvaluation重新审计规则或合规包重新审计某条规则或某个合规包中的所有规则。
IgnoreEvaluationResults忽略规则评估结果忽略某条规则对某些资源的评估结果。您还可以设置规则的忽略时间,当忽略到期后,自动恢复显示该规则对资源的检测结果。
RevertEvaluationResults恢复已忽略规则的评估结果恢复已忽略的某条规则对某些资源的评估结果后,继续显示该规则对资源的评估结果。
GenerateConfigRulesReport生成规则评估报告生成规则的合规评估报告。
GetConfigRulesReport下载规则评估报告下载Excel格式的规则合规评估报告到本地,便于您云下分配任务并跟进不合规资源配置的修改。
GetConfigRuleSummaryByRiskLevel查询规则风险等级维度的合规概要从规则的风险等级维度查询合规概要。
GetResourceComplianceByConfigRule查询规则合规评估结果维度的合规概要从规则的合规评估结果维度查询合规概要。
GetComplianceSummary查询合规统计概览信息查询当前账号下合规统计概览信息。
ListConfigRuleEvaluationStatistics查询当前账号合规统计趋势查询当前账号的合规统计趋势。
多账号多账号
CreateAggregateConfigRule创建账号组规则为指定账号组基于模板创建规则或基于函数计算创建自定义规则,通过规则检测资源的合规性。新建规则后,规则会自动执行一次评估,后续配置审计将根据规则的触发机制自动触发评估,您也可以手动执行评估。
UpdateAggregateConfigRule修改账号组规则修改指定账号组内规则的描述信息、规则入参和风险等级等。
ListAggregateConfigRules查询账号组的规则列表查询指定账号组内的规则列表。
GetAggregateConfigRule查询账号组规则详情查询指定账号组内指定规则详情。
ListAggregateConfigRuleEvaluationResults查询账号组规则的评估结果从规则维度查询指定账号组内规则对资源的评估结果。
ListAggregateResourceEvaluationResults查询账号组资源的评估结果从资源维度查询指定账号组内规则对资源的评估结果。
DeleteAggregateConfigRules删除规则删除指定账号组内的规则。删除规则后,其配置信息不再保留。
DeactiveAggregateConfigRules停用账号组规则停用指定账号组内的规则。停用规则后,不再对资源进行评估,仍显示停用前的合规评估结果。
ActiveAggregateConfigRules启用账号组规则启用指定账号组内的规则。启用规则后,规则继续按照触发机制自动对资源进行评估。
StartAggregateConfigRuleEvaluation重新审计账号组规则或合规包重新审计指定账号组内的某条规则或某个合规包中的所有规则。
IgnoreAggregateEvaluationResults忽略账号组规则评估结果忽略某个账号组下某条规则对某些资源的评估结果。您还可以设置规则的忽略时间,当忽略到期后,自动恢复显示该规则对资源的检测结果。
RevertAggregateEvaluationResults恢复已忽略账号组规则的评估结果恢复已忽略账号组内某条规则对某些资源的评估结果后,继续显示该规则对资源的评估结果。
GenerateAggregateConfigRulesReport生成账号组规则评估报告为指定账号组内规则列表中的规则生成评估报告。
GetAggregateConfigRulesReport下载账号组规则评估报告下载Excel格式的规则合规评估报告到本地,便于您云下分配任务并跟进不合规资源配置的修改。
GetAggregateConfigRuleSummaryByRiskLevel查询账号组规则风险等级维度的合规概要从指定账号组内规则的风险等级维度查询合规概要。
GetAggregateResourceComplianceByConfigRule查询账号组规则合规评估结果维度的合规概要从指定账号组内规则的合规评估结果维度查询合规概要。
GetAggregateComplianceSummary查询账号组内合规统计概览信息查询指定账号组的合规统计概览信息。
ListAggregateConfigRuleEvaluationStatistics查询账号组的合规统计趋势查询目标账号组的合规统计趋势。
CopyConfigRules复制规则将一个账号组中的规则复制到另外一个账号组中。
ListManagedRules查询规则模板列表查询配置审计支持的规则模板列表。
GetManagedRule查询规则模板详情查询指定规则模板的详细信息。
PutEvaluations提交自定义函数规则评估结果函数计算通过PutEvaluations接口将资源评估结果返回给配置审计。
ListPreManagedRules查询预检规则列表查询配置审计支持的预检规则列表。
EvaluatePreConfigRules执行预检规则评估资源执行预检规则对资源进行合规预检。

合规包

API标题API概述
单账号单账号
CreateCompliancePack创建合规包为当前账号创建合规包。
UpdateCompliancePack修改合规包信息修改当前账号指定合规包的信息。
ListCompliancePacks查询合规包列表查询当前账号的合规包列表。
GetCompliancePack查询合规包详情查询指定的合规包详情。
DeleteCompliancePacks删除合规包删除指定合规包。删除合规包后,该合规包的检查结果和检查报告也自动被删除。
GenerateCompliancePackReport生成合规包评估报告生成合规包的评估报告。
GetCompliancePackReport获取合规包评估报告获取合规包的评估报告。
GetConfigRuleComplianceByPack查询合规包中规则维度合规统计查询指定合规包中规则维度合规统计。
GetResourceComplianceByPack查询合规包资源合规结果查询合规包中资源的合规结果。
AttachConfigRuleToCompliancePack将规则加入合规包将指定规则加入指定合规包。
DetachConfigRuleToCompliancePack将规则从合规包中移出将指定规则从指定合规包中移出。
多账号多账号
CreateAggregateCompliancePack创建账号组合规包为指定账号组创建合规包。
UpdateAggregateCompliancePack修改账号组合规包信息修改指定账号组内的合规包信息。
ListAggregateCompliancePacks查询账号组合规包列表查询指定账号组内的合规包列表。
GetAggregateCompliancePack查询账号组合规包详情查询指定账号组内合规包详情。
DeleteAggregateCompliancePacks删除账号组合规包删除指定账号组内的合规包。删除合规包后,该合规包的检查结果和检查报告也自动被删除。
GenerateAggregateCompliancePackReport生成账号组合规包评估报告为指定账号组内的指定合规包生成评估报告。
GetAggregateCompliancePackReport获取账号组合规包评估报告获取指定账号组内指定合规包的评估报告。
GetAggregateResourceComplianceByPack查询账号组合规包资源合规统计查询指定账号组内指定合规包中资源的合规统计。
GetAggregateConfigRuleComplianceByPack查询账号组合规包规规则合规结果查询指定账号组内指定合规包中规则的合规结果。
GetAggregateAccountComplianceByPack查询账号组合规包中成员合规结果查询指定账号组内指定合规包中成员账号的合规结果。
AttachAggregateConfigRuleToCompliancePack将账号组规则加入合规包将指定账号组规则加入指定账号组合规包。
DetachAggregateConfigRuleToCompliancePack将账号组规则从合规包中移出将指定账号组规则从指定账号组合规包中移出。
CopyCompliancePacks复制合规包管理账号或配置审计委派管理员可以将一个账号组中的合规包复制到另外一个账号组中,高效地管理多个账号组内成员的规则集。
ListCompliancePackTemplates查询合规包模板查询配置审计提供的所有合规包模板及其详细信息。

修正设置

API标题API概述
单账号单账号
CreateRemediation创建修正设置为已有规则设置修正。
UpdateRemediation更新修正设置更新指定的修正设置。
ListRemediations获取修正列表获取修正列表信息。
DeleteRemediations删除修正设置删除指定修正设置。
StartRemediation手动执行规则修正手动执行指定的规则修正。
ListRemediationExecutions查看规则修正执行记录查看指定规则的修正执行记录。
DescribeRemediation查询修正设置本文将提供一个示例,查询修正设置crr-f381cf0c1c2f004e****的详情。
多账号多账号
CreateAggregateRemediation创建账号组的修正设置为指定账号组规则创建修正。
UpdateAggregateRemediation更新账号组的修正设置更新指定的规则修正。
ListAggregateRemediations查询账号组的修正设置列表查询指定账号组下所有修正列表。
DeleteAggregateRemediations删除账号组的修正设置删除指定账号组规则的修正设置。
StartAggregateRemediation手动执行账号组的修正设置手动执行指定的账号组规则修正。
ListAggregateRemediationExecutions查询账号组的修正执行记录查询指定账号组内规则的修正执行记录。
ListRemediationTemplates获取修正模板列表获取修正模板列表信息。
GetRemediationTemplate查看自动修正模板详情查看自动修正模板详情。

投递渠道

API标题API概述
单账号单账号
CreateConfigDeliveryChannel创建投递渠道创建投递渠道,将资源数据投递到日志服务SLS、对象存储OSS或消息服务MNS进行储存。
UpdateConfigDeliveryChannel修改投递渠道修改投递渠道。
DeleteConfigDeliveryChannel删除投递渠道删除投递渠道后,投递到日志服务SLS、对象存储OSS和消息服务MNS的资源数据同步被删除,且不可恢复。
ListConfigDeliveryChannels查询投递渠道列表查询投递渠道列表。
GetConfigDeliveryChannel查询指定投递渠道信息查询指定投递渠道信息。
CreateDeliveryChannel创建投递渠道(不推荐)创建投递渠道。
UpdateDeliveryChannel更新投递渠道信息(不推荐)修改投递渠道。
多账号多账号
CreateAggregateConfigDeliveryChannel为指定账号组创建投递渠道为指定账号组创建投递渠道,将资源数据投递到日志服务SLS、对象存储OSS或消息服务MNS进行储存。
UpdateAggregateConfigDeliveryChannel修改指定账号组内的投递渠道修改指定账号组内的投递渠道。
DeleteAggregateConfigDeliveryChannel删除账号组投递渠道删除投递渠道后,投递到日志服务SLS、对象存储OSS和消息服务MNS的资源数据同步被删除,且不可恢复。
ListAggregateConfigDeliveryChannels查询指定账号组内的所有投递渠道信息查询指定账号组内的所有投递渠道信息。
GetAggregateConfigDeliveryChannel查询指定账号组内的指定投递渠道信息查询指定账号组内的指定投递渠道信息。

标签

API标题API概述
ListTagResources查询指定资源绑定的标签查询配置审计中资源绑定的标签。
TagResources绑定标签为配置审计的规则、账号组和合规包绑定标签。
UntagResources解绑标签为配置审计中的资源解绑标签。

集成服务

API标题API概述
GetIntegratedServiceStatus查询指定云服务的集成状态查询指定云服务的集成状态。
UpdateIntegratedServiceStatus开启指定集成服务开启或关闭指定云产品的集成状态。
ListIntegratedService查询集成服务列表及其状态查询配置审计集成的服务列表及其状态。

服务设置

API标题API概述
GetConfigurationRecorder查询服务启用状态和资源监控范围查询当前账号的配置审计服务启用状态和资源监控范围。
StartConfigurationRecorder开启配置审计服务开启配置审计服务并设置资源监控范围为全部。
UpdateConfigurationRecorder修改资源监控范围修改当前账号的资源监控范围。
StopConfigurationRecorder停用配置审计服务关闭配置审计服务。