备案控制台
文档
产品文档
输入文档关键字查找
首页 配置审计 开发参考 API参考 API参考（2020-09-07） API概览

API概览

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

资源

API标题API概述
单账号单账号
ListDiscoveredResources获取资源列表信息获取当前账号的资源列表信息。
GetDiscoveredResource获取资源详情获取资源详细信息。
ListResourceRelations查询资源的关系列表查询资源的关系列表。
GetResourceConfigurationTimeline查询资源配置时间线查询指定资源的配置时间线。
GetResourceComplianceTimeline查询资源合规时间线查询指定资源的合规时间线。
ListResourcesByAdvancedSearch应用高级搜索查询资源列表应用高级搜索查找当前账号内的资源列表。
CreateAdvancedSearchFile创建资源高级搜索下载文件为当前账号创建资源高级搜索下载文件。
GetAdvancedSearchFile查询资源高级搜索下载文件查询当前账号下最近生成的资源高级搜索下载文件。
GenerateResourceInventory生成全局资源下载清单生成全局资源下载清单。
GetResourceInventory获取全局资源下载清单信息获取当前账号最近生成的全局资源下载清单信息。
GetDiscoveredResourceCountsGroupByRegion查询资源的地域维度统计结果从地域维度查询资源的统计结果。
GetDiscoveredResourceCountsGroupByResourceType查询资源的资源类型维度统计结果从资源类型维度查询资源的统计结果。
GetResourceComplianceGroupByResourceType获取指定规则的按资源类型进行分组的评估结果获取指定规则的按资源类型进行分组的评估结果。
GetResourceComplianceGroupByRegion获取指定规则的按资源所属地域进行分组的评估结果获取指定规则的按资源所属地域进行分组的评估结果。
多账号多账号
ListAggregateDiscoveredResources获取账号组内资源列表获取账号组内资源的列表信息。
GetAggregateDiscoveredResource获取账号组内资源详情获取账号组内资源详细信息。
ListAggregateResourceRelations查询账号组内资源的关系列表查询账号组内资源的关系列表。
GetAggregateResourceConfigurationTimeline查询账号组资源配置时间线查询指定账号组内指定资源的配置时间线。
GetAggregateResourceComplianceTimeline查询账号组资源合规时间线查询指定账号组内指定资源的合规时间线。
ListAggregateResourcesByAdvancedSearch应用高级搜索查询账号组内资源列表本文将提供一个示例，应用高级搜索查询账号组内所有具有标签键为business且标签值为online的资源。
CreateAggregateAdvancedSearchFile为目标账号组创建资源高级搜索下载文件为目标账号组创建资源高级搜索下载文件。
GetAggregateAdvancedSearchFile查询账号组内资源高级搜索下载文件查询指定账号组下最近生成的资源高级搜索下载文件。
GenerateAggregateResourceInventory生成账号组内全局资源下载清单生成指定的账号组内全局资源下载清单。
GetAggregateResourceInventory查询账号组的全局资源下载清单信息获取指定的账号组内最近生成的全局资源下载清单信息。
GetAggregateResourceCountsGroupByRegion查询账号组资源地域维度统计结果从地域维度查询指定账号组内资源的统计结果。
GetAggregateResourceCountsGroupByResourceType查询账号组内资源类型的统计结果从资源类型维度查询指定账号组内资源的统计结果。
GetAggregateResourceComplianceGroupByRegion获取指定账号组规则的按资源所属地域进行分组的评估结果获取指定账号组规则的按资源所属地域进行分组的评估结果。
GetAggregateResourceComplianceGroupByResourceType获取指定账号组规则的按资源类型进行分组的评估结果获取指定账号组规则的按资源类型进行分组的评估结果。
GetSupportedResourceRelationConfig查询资源类型支持的资源关系查询指定的资源类型支持的资源关系。
ListSupportedProducts查询服务支持的云产品列表查询配置审计服务支持的云产品和资源类型列表。

规则

API标题API概述
单账号单账号
CreateConfigRule创建规则为当前账号创建规则。
UpdateConfigRule修改当前账号的规则修改指定的当前账号的规则。
DeactiveConfigRules停用规则停用指定规则。
ListConfigRules查询规则列表获取当前账号规则列表。
GetConfigRule查询规则详情查询指定规则详情。
ListConfigRuleEvaluationResults查询评估列表查询指定规则的评估结果列表。
ListResourceEvaluationResults查询资源评估结果查询指定资源的评估结果。
StartConfigRuleEvaluation对规则或合规包进行重新审计对指定的规则或者合规包进行重新审计。
ActiveConfigRules启用规则调用ActiveConfigRules接口批量启用指定规则，使规则状态处于“应用中”。
DeleteConfigRules批量删除规则删除指定规则。
IgnoreEvaluationResults忽略规则评估结果忽略规则评估的指定结果。
RevertEvaluationResults恢复已忽略的评估结果恢复已忽略的规则评估的指定结果。
GenerateConfigRulesReport生成规则列表评估报告生成规则列表中所有规则的评估报告。
GetConfigRulesReport获取规则列表评估报告获取规则列表中所有规则的评估报告。
AttachConfigRuleToCompliancePack将规则加入合规包将指定规则加入指定合规包。
DetachConfigRuleToCompliancePack将规则从合规包中移出将指定规则从指定合规包中移出。
GetConfigRuleSummaryByRiskLevel查询规则风险等级维度的合规概要查询不同风险等级规则的合规概要。
GetResourceComplianceByConfigRule查询规则的资源合规统计查询指定规则对资源的评估结果。
GetComplianceSummary查询合规统计概览信息查询当前账号下合规统计概览信息。
ListConfigRuleEvaluationStatistics查询当前账号合规统计趋势查询当前账号的合规统计趋势。
多账号多账号
CreateAggregateConfigRule创建账号组规则为指定账号组创建规则。
UpdateAggregateConfigRule修改账号组规则修改指定账号组内的规则。
DeleteAggregateConfigRules删除规则删除指定账号组内的规则。
ListAggregateConfigRules查询账号组的规则列表查询指定账号组内的规则列表。
GetAggregateConfigRule查询账号组规则详情查询指定账号组内指定规则详情。
ListAggregateConfigRuleEvaluationResults查询账号组规则的评估结果列表查询指定账号组内规则对资源的评估结果列表。
ListAggregateResourceEvaluationResults查询账号组规则评估结果列表查询指定账号组内资源的合规评估结果列表。
ActiveAggregateConfigRules启用账号组规则启用指定账号组内的规则。
DeactiveAggregateConfigRules停用账号组规则停用指定账号组内的规则。
IgnoreAggregateEvaluationResults忽略账号组规则评估结果忽略账号组评估的指定结果。
RevertAggregateEvaluationResults恢复已忽略的账号组评估结果恢复已忽略的账号组规则评估的指定结果。
AttachAggregateConfigRuleToCompliancePack将账号组规则加入合规包将指定账号组规则加入指定账号组合规包。
DetachAggregateConfigRuleToCompliancePack将账号组规则从合规包中移出将指定账号组规则从指定账号组合规包中移出。
StartAggregateConfigRuleEvaluation重新审计账号组规则使指定账号组内的规则执行一次评估。
GenerateAggregateConfigRulesReport生成账号组规则评估报告为指定账号组内规则列表中的所有规则生成评估报告。
GetAggregateConfigRulesReport获取账号组规则列表评估报告获取指定账号组内规则列表中所有规则的评估报告。
GetAggregateConfigRuleSummaryByRiskLevel查询账号组规则风险等级合规概要查询指定账号组内不同风险等级规则的合规概要。
GetAggregateResourceComplianceByConfigRule获取账号组规则的评估结果查询指定账号组内规则对资源的合规评估结果。
GetAggregateComplianceSummary查询账号组内合规统计概览信息查询指定账号组的合规统计概览信息。
ListAggregateConfigRuleEvaluationStatistics查询账号组的合规统计趋势查询目标账号组的合规统计趋势。
ListManagedRules查询托管规则列表获取托管规则列表信息。
GetManagedRule获取托管规则详情获取指定的托管规则详细信息。
PutEvaluations提交自定义函数规则评估结果调用PutEvaluations接口提交自定义函数规则的评估结果。
ListPreManagedRules获取预检规则列表获取预检规则列表信息。
EvaluatePreConfigRules执行预检规则评估执行预检规则评估。
CopyConfigRules复制规则复制规则。

合规包

API标题API概述
单账号单账号
CreateCompliancePack创建合规包为当前账号创建合规包。
UpdateCompliancePack修改合规包信息修改指定的当前账号合规包信息。
ListCompliancePacks查询合规包列表查询当前账号的合规包列表。
GetCompliancePack查询合规包详情查询指定的合规包详情。
DeleteCompliancePacks删除合规包删除指定合规包。
GenerateCompliancePackReport生成合规包评估报告生成合规包的评估报告。
GetCompliancePackReport获取合规包评估报告获取合规包的评估报告。
GetConfigRuleComplianceByPack查询合规包中规则维度合规统计查询指定合规包中规则维度合规统计。
GetResourceComplianceByPack查询合规包资源合规结果查询合规包中资源的合规结果。
多账号多账号
CreateAggregateCompliancePack创建账号组合规包为指定账号组创建合规包。
UpdateAggregateCompliancePack修正账号组合规包信息修改指定账号组内的合规包信息。
ListAggregateCompliancePacks查询账号组合规包列表查询指定账号组内的合规包列表。
GetAggregateCompliancePack查询账号组合规包详情查询指定账号组内合规包详情。
DeleteAggregateCompliancePacks删除账号组合规包删除指定账号组内的合规包。
GenerateAggregateCompliancePackReport生成账号组合规包评估报告为指定账号组内的指定合规包生成评估报告。
GetAggregateCompliancePackReport获取账号组合规包评估报告获取指定账号组内指定合规包的评估报告。
GetAggregateResourceComplianceByPack查询账号组合规包资源合规统计查询指定账号组内指定合规包中资源的合规统计。
GetAggregateConfigRuleComplianceByPack查询账号组合规包规规则合规结果查询指定账号组内指定合规包中规则的合规结果。
GetAggregateAccountComplianceByPack查询账号组合规包中成员合规结果查询指定账号组内指定合规包中成员账号的合规结果。
ListCompliancePackTemplates查询合规包模板查询合规包模板列表。
CopyCompliancePacks复制合规包复制合规包。

修正设置

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

投递渠道

API标题API概述
单账号单账号
CreateConfigDeliveryChannel创建投递渠道创建投递渠道。
UpdateConfigDeliveryChannel修改投递渠道修改投递渠道。
DeleteConfigDeliveryChannel删除个人投递渠道删除指定投递渠道。
ListConfigDeliveryChannels查询投递渠道列表查询投递渠道列表。
GetConfigDeliveryChannel查询指定投递渠道信息查询指定投递渠道信息。
CreateDeliveryChannel创建投递渠道（不推荐）创建投递渠道。
UpdateDeliveryChannel更新投递渠道信息（不推荐）修改投递渠道。
多账号多账号
CreateAggregateConfigDeliveryChannel为指定账号组创建投递渠道为指定账号组创建投递渠道。
UpdateAggregateConfigDeliveryChannel修改指定账号组内的投递渠道修改指定账号组内的投递渠道。
DeleteAggregateConfigDeliveryChannel删除账号组投递渠道删除指定账号组的指定投递渠道。
ListAggregateConfigDeliveryChannels查询指定账号组内的所有投递渠道信息查询指定账号组内的所有投递渠道信息。
GetAggregateConfigDeliveryChannel查询指定账号组内的指定投递渠道信息查询指定账号组内的指定投递渠道信息。

账号组

API标题API概述
CreateAggregator创建账号组创建一个账号组。
UpdateAggregator更新账号组更新账号组的配置。
DeleteAggregators删除账号组删除指定账号组。
ListAggregators查询账号组列表查询当前账号管理或所在的账号组列表。
GetAggregator查询账号组详情查询指定的账号组详情。

标签

API标题API概述
ListTagResources查询指定资源绑定的标签查询指定资源绑定的标签。
TagResources绑定标签为指定资源绑定标签。
UntagResources解绑标签为指定资源解绑标签。

集成服务

API标题API概述
GetIntegratedServiceStatus查询指定云产品的集成状态查询指定云产品的集成状态。
UpdateIntegratedServiceStatus开启指定集成服务开启或关闭指定云产品的集成状态。
ListIntegratedService查询可集成服务列表状态查询当前账号可集成的服务列表状态。

服务设置

API标题API概述
GetConfigurationRecorder查询服务启用状态和资源监控范围查询当前账号的配置审计服务启用状态和资源监控范围。
StartConfigurationRecorder开启配置审计服务开启配置审计服务并设置资源监控范围为全部。
UpdateConfigurationRecorder修改资源监控范围修改当前账号的资源监控范围。
StopConfigurationRecorder停用配置审计服务关闭配置审计服务。
文档推荐
  • 本页导读 （1）
文档反馈