本文为您介绍配置审计提供的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接口关闭配置审计服务。