API概览

本产品(Config/2019-01-08)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

资源

API

标题

API概述

GetDiscoveredResourceCounts 查询资源数量 查询当前账号的资源数量。
ListDiscoveredResources 查询资源列表 查询当前账号资源列表。
DescribeDiscoveredResource 查询资源配置详情 查询指定资源的配置详情。
GetResourceComplianceTimeline 查询资源合规时间线 查询指定资源的合规时间线。
GetResourceConfigurationTimeline 查询资源配置时间线 查询指定资源的配置时间线。
GetDiscoveredResourceSummary 查询资源概览 查询监控中的资源概览。
GetSupportedResourceTypes 查询配置审计支持的资源类型列表 查询配置审计支持的所有资源类型列表。

规则

API

标题

API概述

DeleteConfigRules 批量删除规则 批量删除指定规则。
StartConfigRuleEvaluation 启用指定规则 使该规则执行一次评估。
StopConfigRules 批量停用指定规则 批量停用指定规则,使规则处于“已停用”状态。
ListConfigRules 查询规则列表 查询当前账号规则列表。
DescribeEvaluationResults 查询规则评估结果 查询规则的评估结果列表。
DescribeCompliance 查询合规结果统计 查询资源的合规结果统计。
DescribeComplianceSummary 查询合规结果统计概要 查询当前账号的合规结果统计概要。
DescribeConfigRule 查询规则详情 查询指定的规则详情。
PutConfigRule 新建或修改规则 为当前账号新建或修改规则。
PutEvaluations 提交评估结果 提交规则评估结果。
ActiveConfigRules 批量启用指定规则 批量启用指定规则,使规则状态处于“应用中”。

资源监控范围

API

标题

API概述

StartConfigurationRecorder 设置资源监控范围 设置当前账号的资源监控范围。
DescribeConfigurationRecorder 查询资源监控范围 查询设置的资源监控范围。
PutConfigurationRecorder 修改监控中的资源类型 新增或修改监控中的资源类型。

投递渠道

API

标题

API概述

DescribeDeliveryChannels 查询投递渠道信息 查询设置的投递渠道信息。
PutDeliveryChannel 创建或更新投递渠道 为当前账号创建或更新投递渠道。

其他

API

标题

API概述

GetAggregateDiscoveredResource 查询资源详情 查询指定账号组内指定资源详情。
ListAggregateDiscoveredResources 查询账号组资源列表 查询指定账号组内的资源列表。
ListRemediationTemplates 查询修正模板详情 查询指定托管规则的修正模板详情。