本文为您介绍配置审计提供的API。

普通账号

普通账号是指未被企业管理账号加入资源目录的独立的阿里云账号。普通账号可以调用的API如下表所示。

功能API描述
合规包ListCompliancePackTemplates调用ListCompliancePackTemplates接口查询合规包模板列表。
CreateCompliancePack调用CreateCompliancePack接口创建合规包。
ListCompliancePacks调用ListCompliancePacks接口查询合规包列表。
GetCompliancePack调用GetCompliancePack接口查询合规包详情。
UpdateCompliancePack调用UpdateCompliancePack接口修改合规包信息。
DeleteCompliancePacks调用DeleteCompliancePacks接口删除合规包。
GenerateCompliancePackReport调用GenerateCompliancePackReport接口生成合规包的评估报告。
GetCompliancePackReport调用GetCompliancePackReport接口查询合规包的评估报告。
GetConfigRuleComplianceByPack调用GetConfigRuleComplianceByPack接口查询合规包中规则的合规结果。
GetResourceComplianceByPack调用GetResourceComplianceByPack接口查询合规包中资源的合规结果。
CopyCompliancePacks调用CopyCompliancePacks接口复制合规包。
规则CreateConfigRule调用CreateConfigRule接口创建规则。
UpdateConfigRule调用UpdateConfigRule接口修改规则。
GetConfigRule调用GetConfigRule接口查询指定规则详情。
DeactiveConfigRules调用DeactiveConfigRules接口停用规则。
ListResourceEvaluationResults调用ListResourceEvaluationResults接口查询资源评估结果。
ListConfigRuleEvaluationResults调用ListConfigRuleEvaluationResults接口查询规则对资源的评估结果。
GenerateConfigRulesReport调用GenerateConfigRulesReport接口生成规则列表中所有规则的评估报告。
GetConfigRulesReport调用GetConfigRulesReport接口查询规则列表中所有规则的评估报告。
GetResourceComplianceByConfigRule调用GetResourceComplianceByConfigRule接口查询规则对资源的评估结果。
GetConfigRuleSummaryByRiskLevel调用GetConfigRuleSummaryByRiskLevel接口查询不同风险等级规则的合规概要。
AttachConfigRuleToCompliancePack调用AttachConfigRuleToCompliancePack接口将指定规则加入指定合规包。
DetachConfigRuleToCompliancePack调用DetachConfigRuleToCompliancePack接口将指定规则移出指定合规包。
IgnoreEvaluationResults调用IgnoreEvaluationResults接口忽略指定规则对指定不合规资源的评估结果。
RevertEvaluationResults调用RevertEvaluationResults接口恢复指定规则对指定不合规资源的评估结果。
ListManagedRules调用ListManagedRules接口查询托管规则列表。
GetManagedRule调用GetManagedRule接口查询指定托管规则的详情。
ListPreManagedRules调用ListPreManagedRules接口查询预检规则列表。
EvaluatePreConfigRules调用EvaluatePreConfigRules接口执行预检规则评估。
CopyConfigRules调用CopyConfigRules接口复制规则。
资源GetResourceComplianceTimeline调用GetResourceComplianceTimeline接口查询指定资源的合规时间线。
GetResourceConfigurationTimeline调用GetResourceConfigurationTimeline接口查询指定资源的配置时间线。
GetDiscoveredResourceCountsGroupByResourceType调用GetDiscoveredResourceCountsGroupByResourceType接口从资源类型维度查询资源的统计结果。
GetDiscoveredResourceCountsGroupByRegion调用GetDiscoveredResourceCountsGroupByRegion接口从地域维度查询资源的统计结果。
GetDiscoveredResource调用GetDiscoveredResource接口查询指定资源详情。
ListDiscoveredResources调用ListDiscoveredResources接口查询资源列表。
修正设置ListRemediationTemplates调用ListRemediationTemplates接口查询指定托管规则的官方修正模板列表。
CreateRemediation调用CreateRemediation接口为指定规则创建修正设置。
ListRemediations调用ListRemediations接口查询规则的修正设置。
DeleteRemediations调用DeleteRemediations接口删除规则的修正设置。
StartRemediation调用StartRemediation接口使规则手动执行一次修正。
投递渠道CreateConfigDeliveryChannel调用CreateDeliveryChannel接口创建投递渠道。
UpdateConfigDeliveryChannel调用UpdateConfigDeliveryChannel接口修改投递渠道。
ListConfigDeliveryChannels调用ListConfigDeliveryChannels接口查询所有投递渠道信息。
GetConfigDeliveryChannel调用GetConfigDeliveryChannel接口查询指定投递渠道信息。
（不推荐）CreateDeliveryChannel调用CreateDeliveryChannel接口创建投递渠道。
（不推荐）UpdateDeliveryChannel调用UpdateDeliveryChannel接口修改投递渠道。

企业管理账号

企业管理账号是指开通资源目录并管理成员账号的阿里云账号。企业管理账号可以调用的API如下表所示。

功能API描述
账号组CreateAggregator调用CreateAggregator接口创建账号组。
ListAggregators调用ListAggregators接口查询账号组列表。
GetAggregator调用GetAggregator接口查询账号组详情。
UpdateAggregator调用UpdateAggregator接口更新账号组的配置。
DeleteAggregators调用DeleteAggregators接口删除账号组。
合规包ListCompliancePackTemplates调用ListCompliancePackTemplates接口查询合规包模板列表。
CreateAggregateCompliancePack调用CreateAggregateCompliancePack接口为指定账号组创建合规包。
ListAggregateCompliancePacks调用ListAggregateCompliancePacks接口查询指定账号组内的合规包列表。
GetAggregateCompliancePack调用GetAggregateCompliancePack接口查询指定账号组内合规包详情。
UpdateAggregateCompliancePack调用UpdateAggregateCompliancePack接口修改指定账号组内的合规包信息。
DeleteAggregateCompliancePacks调用DeleteAggregateCompliancePacks接口删除指定账号组内的合规包。
GenerateAggregateCompliancePackReport调用GenerateAggregateCompliancePackReport接口为指定账号组内的指定合规包生成评估报告。
GetAggregateCompliancePackReport调用GetAggregateCompliancePackReport接口下载指定账号组内指定合规包的评估报告。
GetAggregateResourceComplianceByPack调用GetAggregateResourceComplianceByPack接口查询指定账号组内指定合规包中资源的合规结果。
GetAggregateConfigRuleComplianceByPack调用GetAggregateConfigRuleComplianceByPack接口查询指定账号组内指定合规包中规则的合规结果。
GetAggregateAccountComplianceByPack调用GetAggregateAccountComplianceByPack接口查询指定账号组内指定合规包中成员账号的合规结果。
规则CreateAggregateConfigRule调用CreateAggregateConfigRule接口为指定账号组创建规则。
ListAggregateConfigRules调用ListAggregateConfigRules接口查询指定账号组内的规则列表。
GetAggregateConfigRule调用GetAggregateConfigRule接口查询指定账号组内指定规则详情。
UpdateAggregateConfigRule调用UpdateAggregateConfigRule接口修改指定账号组内的规则。
DeleteAggregateConfigRules调用DeleteAggregateConfigRules接口删除指定账号组内的规则。
ActiveAggregateConfigRules调用ActiveAggregateConfigRules接口启用指定账号组内的规则。
DeactiveAggregateConfigRules调用DeactiveAggregateConfigRules接口停用指定账号组内的规则。
GenerateAggregateConfigRulesReport调用GenerateAggregateConfigRulesReport接口为指定账号组内规则列表中的所有规则生成评估报告。
GetAggregateConfigRulesReport调用GetAggregateConfigRulesReport接口下载指定账号组内规则列表中所有规则的评估报告。
StartAggregateConfigRuleEvaluation调用StartAggregateConfigRuleEvaluation接口使指定账号组内的规则执行一次评估。
GetAggregateResourceComplianceByConfigRule调用GetAggregateResourceComplianceByConfigRule接口查询指定账号组内规则对资源的评估结果。
GetAggregateConfigRuleSummaryByRiskLevel调用GetAggregateConfigRuleSummaryByRiskLevel接口查询指定账号组内不同风险等级规则的合规概要。
ListAggregateConfigRuleEvaluationResults调用ListAggregateConfigRuleEvaluationResults接口查询指定账号组内规则对资源的评估结果。
ListAggregateResourceEvaluationResults调用ListAggregateResourceEvaluationResults接口查询指定账号组内资源的评估结果。
AttachAggregateConfigRuleToCompliancePack调用AttachAggregateConfigRuleToCompliancePack接口将指定账号组中的指定规则加入指定合规包。
DetachAggregateConfigRuleToCompliancePack调用DetachAggregateConfigRuleToCompliancePack接口将指定账号组中的指定规则移出指定合规包。
IgnoreAggregateEvaluationResults调用IgnoreAggregateEvaluationResults接口忽略指定账号组内指定规则对指定不合规资源评估结果。
RevertAggregateEvaluationResults调用RevertAggregateEvaluationResults接口恢复指定账号组内指定规则对指定不合规资源评估结果。
资源GetAggregateResourceCountsGroupByResourceType调用GetAggregateResourceCountsGroupByResourceType接口从资源类型维度查询指定账号组内资源的统计结果。
GetAggregateResourceCountsGroupByRegion调用GetAggregateResourceCountsGroupByRegion接口从地域维度查询指定账号组内资源的统计结果。
GetAggregateResourceConfigurationTimeline调用GetAggregateResourceConfigurationTimeline接口查询指定账号组内指定资源的配置时间线。
GetAggregateResourceComplianceTimeline调用GetAggregateResourceComplianceTimeline接口查询指定账号组内指定资源的合规时间线。
GetAggregateDiscoveredResource调用GetAggregateDiscoveredResource接口查询指定账号组内的资源详情。
ListAggregateDiscoveredResources调用ListAggregateDiscoveredResources接口查询指定账号组内的资源列表。
修正设置CreateAggregateRemediation调用CreateAggregateRemediation接口为账号组内的指定规则创建修正设置。
ListAggregateRemediations调用ListAggregateRemediations接口查询指定账号组内规则的修正设置。
DeleteAggregateRemediations调用DeleteAggregateRemediations接口删除账号组内规则的修正设置。
StartAggregateRemediation调用StartAggregateRemediation接口使指定账号组内的规则手动执行一次修正。

成员账号

成员账号是指资源目录中的成员账号。成员账号可以调用的API，会根据其是否加入账号组而存在差异。具体如下：
  • 当成员账号未加入账号组时，可以调用普通账号中的所有API。更多信息，请参见普通账号。
  • 当成员账号加入账号组时，不仅可以调用普通账号中的所有API，还可以调用企业管理账号中的查询类API，查询当前成员账号归属的账号组，以及拥有的合规包、规则、资源和修正设置。
    • 普通账号中的所有API。更多信息，请参见普通账号。
    • 企业管理账号中的查询类API。具体如下表所示。
      功能API描述
      账号组ListAggregators调用ListAggregators接口查询账号组列表。
      GetAggregator调用GetAggregator接口查询账号组详情。
      合规包ListAggregateCompliancePacks调用ListAggregateCompliancePacks接口查询指定账号组内的合规包列表。
      GetAggregateCompliancePack调用GetAggregateCompliancePack接口查询指定账号组内合规包详情。
      GetAggregateResourceComplianceByPack调用GetAggregateResourceComplianceByPack接口查询指定账号组内指定合规包中资源的合规结果。
      GetAggregateConfigRuleComplianceByPack调用GetAggregateConfigRuleComplianceByPack接口查询指定账号组内指定合规包中规则的合规结果。
      GetAggregateAccountComplianceByPack调用GetAggregateAccountComplianceByPack接口查询指定账号组内指定合规包中成员账号的合规结果。
      规则ListAggregateConfigRules调用ListAggregateConfigRules接口查询指定账号组内的规则列表。
      GetAggregateConfigRule调用GetAggregateConfigRule接口查询指定账号组内指定规则详情。
      GetAggregateResourceComplianceByConfigRule调用GetAggregateResourceComplianceByConfigRule接口查询指定账号组内规则对资源的评估结果。
      GetAggregateConfigRuleSummaryByRiskLevel调用GetAggregateConfigRuleSummaryByRiskLevel接口查询指定账号组内不同风险等级规则的合规概要。
      ListAggregateConfigRuleEvaluationResults调用ListAggregateConfigRuleEvaluationResults接口查询指定账号组内规则对资源的评估结果。
      说明
      • 如果您未设置请求参数ResourceOwnerId，配置审计默认查询当前成员账号的规则对资源的评估结果。
      • 如果您想设置请求参数ResourceOwnerId，必须设置为当前成员账号ID。
      ListAggregateResourceEvaluationResults调用ListAggregateResourceEvaluationResults接口查询指定账号组内资源的评估结果。
      资源ListAggregateDiscoveredResources调用ListAggregateDiscoveredResources接口查询指定账号组内的资源列表。
      说明
      • 如果您未设置请求参数ResourceOwnerId，配置审计默认查询当前成员账号的资源列表。
      • 如果您想设置请求参数ResourceOwnerId，必须设置为当前成员账号ID。
      GetAggregateDiscoveredResource调用GetAggregateDiscoveredResource接口查询指定账号组内指定资源详情。
      说明
      • 如果您未设置请求参数ResourceOwnerId，配置审计默认查询当前成员账号的资源详情。
      • 如果您想设置请求参数ResourceOwnerId，必须设置为当前成员账号ID。
      GetAggregateResourceCountsGroupByResourceType调用GetAggregateResourceCountsGroupByResourceType接口从资源类型维度查询指定账号组内资源的统计结果。
      GetAggregateResourceCountsGroupByRegion调用GetAggregateResourceCountsGroupByRegion接口从地域维度查询指定账号组内资源的统计结果。
      GetAggregateResourceConfigurationTimeline调用GetAggregateResourceConfigurationTimeline接口查询指定账号组内指定资源的配置时间线。
      说明
      • 如果您未设置请求参数ResourceOwnerId，配置审计默认查询当前成员账号的资源配置时间线。
      • 如果您想设置请求参数ResourceOwnerId，必须设置为当前成员账号ID。
      GetAggregateResourceComplianceTimeline调用GetAggregateResourceComplianceTimeline接口查询指定账号组内指定资源的合规时间线。
      说明
      • 如果您未设置请求参数ResourceOwnerId，配置审计默认查询当前成员账号的资源合规时间线。
      • 如果您想设置请求参数ResourceOwnerId，必须设置为当前成员账号ID。
      修正设置ListAggregateRemediations调用ListAggregateRemediations接口查询指定账号组内规则的修正设置。

标签

普通账号、企业管理账号和成员账号均可调用以下API。
API描述
ListTagResources调用ListTagResources接口查询指定资源绑定的标签。
TagResources调用TagResources接口为指定资源绑定标签。
UntagResources调用UntagResources接口为指定资源解绑标签。

集成服务

普通账号、企业管理账号和成员账号均可调用以下API。
API描述
GetIntegratedServiceStatus调用GetIntegratedServiceStatus接口查询指定云产品的集成状态。
UpdateIntegratedServiceStatus调用UpdateIntegratedServiceStatus接口开启或关闭指定云产品的集成状态。

服务设置

普通账号、企业管理账号和成员账号均可调用以下API。
API描述
StopConfigurationRecorder调用StopConfigurationRecorder接口关闭配置审计服务。