API 概覽 - Cloud Config

API標準及多語言預置SDK

本產品（Config/2020-09-07）的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。

在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。

自訂簽名情境

若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。

帳號與安全準備

阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。

帳號群組

API	標題	API概述
CreateAggregator	建立帳號組	資來源目錄中的管理帳號或委派管理員帳號可以建立帳號組，在帳號組中集中地管理多個成員的資源、合規包和規則。
UpdateAggregator	更新帳號組	資來源目錄中的管理帳號或委派管理員帳號可以修改帳號組的名稱和描述，也可以添加或移除成員。
DeleteAggregators	刪除帳號組	資來源目錄中的管理帳號或委派管理員帳號可以刪除帳號組。
ListAggregators	查詢帳號組列表	查詢當前管理帳號或委派管理員帳號下的所有帳號組列表。
GetAggregator	查詢帳號組詳情	查詢帳號組的名稱、建立時間、成員和帳號群組類型等。

資源

API	標題	API概述
GetSupportedResourceRelationConfig	查詢指定資源類型支援的資源關係	查詢指定資源類型支援的資源關係。
ListSupportedProducts	查詢配置審計支援的雲產品列表	查詢配置審計服務支援的雲產品和資源類型列表。

規則

API	標題	API概述
ListManagedRules	查詢規則模板列表	查詢配置審計支援的規則模板列表。
GetManagedRule	查詢規則模板詳情	查詢指定規則模板的詳細資料。
PutEvaluations	提交自訂函數規則評估結果	Function Compute通過PutEvaluations介面將資源評估結果返回給配置審計。
ListPreManagedRules	查詢預檢規則列表	查詢配置審計支援的預檢規則列表。
EvaluatePreConfigRules	執行預檢規則評估資源	執行預檢規則對資源進行合規預檢。

合規包

API	標題	API概述
ListCompliancePackTemplates	查詢合規包模板	查詢配置審計提供的所有合規包模板及其詳細資料。
多帳號	多帳號

修正設定

API	標題	API概述
單帳號	單帳號
CreateRemediation	建立修正設定	為已有規則設定修正。
UpdateRemediation	更新修正設定	更新指定的修正設定。
ListRemediations	擷取修正列表	擷取修正列表資訊。
DeleteRemediations	刪除修正設定	刪除指定修正設定。
StartRemediation	手動執行規則修正	手動執行指定的規則修正。
ListRemediationExecutions	查看規則修正執行記錄	查看指定規則的修正執行記錄。
DescribeRemediation	查詢修正設定	本文將提供一個樣本，查詢修正設定crr-f381cf0c1c2f004e****的詳情。
多帳號	多帳號
CreateAggregateRemediation	建立帳號組的修正設定	為指定帳號組規則建立修正。
UpdateAggregateRemediation	更新帳號組的修正設定	更新指定的規則修正。
ListAggregateRemediations	查詢帳號組的修正設定列表	查詢指定帳號組下所有修正列表。
DeleteAggregateRemediations	刪除帳號組的修正設定	刪除指定帳號組規則的修正設定。
StartAggregateRemediation	手動執行帳號組的修正設定	手動執行指定的帳號組規則修正。
ListAggregateRemediationExecutions	查詢帳號組的修正執行記錄	查詢指定帳號組內規則的修正執行記錄。
ListRemediationTemplates	擷取修正模板列表	擷取修正模板列表資訊。
GetRemediationTemplate	查看自動修正模板詳情	查看自動修正模板詳情。

投遞通道

API	標題	API概述
GetIntegratedServiceStatus	查詢指定雲端服務的整合狀態	查詢指定雲端服務的整合狀態。
UpdateIntegratedServiceStatus	開啟指定整合服務	開啟或關閉指定雲產品的整合狀態。
ListIntegratedService	查詢整合服務列表及其狀態	查詢配置審計整合的服務列表及其狀態。

整合服務

API	標題	API概述
GetConfigurationRecorder	查詢服務啟用狀態和資源監控範圍	查詢當前帳號的配置審計服務啟用狀態和資源監控範圍。
StartConfigurationRecorder	開啟配置審計服務	開啟配置審計服務並設定資源監控範圍為全部。
UpdateConfigurationRecorder	修改資源監控範圍	修改當前帳號的資源監控範圍。
StopConfigurationRecorder	停用配置審計服務	關閉配置審計服務。

服務設定

API	標題	API概述
CreateReportTemplate	建立報告模版	為當前UID建立合規報告模版。
GetReportTemplate	擷取合規報告模版詳情	擷取合規報告模版詳情。
UpdateReportTemplate	更新合規報告模版	更新合規報告模版。
ListReportTemplates	批量擷取合規報告模版詳情	批量擷取合規報告模版詳情。
DeleteReportTemplate	刪除合規報告模版	刪除合規報告模版。
GenerateReportFromTemplate	基於報告模版產生報告	基於報告模版產生報告Id。
GetReportFromTemplate	擷取基於報告模版產生的最新報告	擷取基於報告模版產生的報告。
TriggerReportSend	根據模版ID即時測試通知已完成的最新報告	即時測試通知。

報告範本

API	標題	API概述
ActiveAggregateConfigRules	啟用帳號組規則	啟用指定帳號組內的規則。啟用規則後，規則繼續按照觸發機制自動對資源進行評估。
ActiveConfigRules	啟用規則	啟用規則後，規則繼續按照觸發機制自動對資源進行評估。
AttachAggregateConfigRuleToCompliancePack	將帳號組規則加入合規包	將指定帳號組規則加入指定帳號組合規包。
AttachConfigRuleToCompliancePack	將規則加入合規包	將指定規則加入指定合規包。
CopyCompliancePacks	複製合規包	管理帳號或配置審計委派管理員可以將一個帳號組中的合規包複製到另外一個帳號組中，高效地管理多個帳號組內成員的規則集。
CopyConfigRules	複製規則	將一個帳號組中的規則複製到另外一個帳號組中。
CreateAdvancedSearchFile	建立資源進階搜尋下載檔案	為當前帳號建立資源進階搜尋下載檔案。
CreateAggregateAdvancedSearchFile	為目標帳號組建立資源進階搜尋下載檔案	為目標帳號組建立資源進階搜尋下載檔案。
CreateAggregateCompliancePack	建立帳號組合規包	為指定帳號組建立合規包。
CreateAggregateConfigDeliveryChannel	為指定帳號組建立投遞渠道	為指定帳號組建立投遞渠道，將資源資料投遞到Log ServiceSLS、Object Storage Service或輕量訊息佇列（原 MNS）進行儲存。
CreateAggregateConfigRule	建立帳號組規則	為指定帳號組基於模板建立規則或基於Function Compute建立自訂規則，通過規則檢測資源的合規性。建立規則後，規則會自動執行一次評估，後續配置審計將根據規則的觸發機制自動觸發評估，您也可以手動執行評估。
CreateCompliancePack	建立合規包	為當前帳號建立合規包。
CreateConfigDeliveryChannel	建立投遞渠道	建立投遞渠道，將資源資料投遞到Log ServiceSLS、Object Storage Service 或輕量訊息佇列（原 MNS）進行儲存。
CreateConfigRule	建立規則	基於模板建立規則或基於Function Compute建立自訂規則，通過規則檢測資源的合規性。建立規則後，規則會自動執行一次評估，後續配置審計將根據規則的觸發機制自動觸發評估，您也可以手動執行評估。
DeactiveAggregateConfigRules	停用帳號組規則	停用指定帳號組內的規則。停用規則後，不再對資源進行評估，仍顯示停用前的合規評估結果。
DeactiveConfigRules	停用規則	停用規則後，不再對資源進行評估，仍顯示停用前的合規評估結果。
DeleteAggregateCompliancePacks	刪除帳號組合規包	刪除指定帳號組內的合規包。刪除合規包後，該合規包的檢查結果和檢查報告也自動被刪除。
DeleteAggregateConfigDeliveryChannel	刪除帳號組投遞渠道	刪除投遞渠道後，投遞到Log ServiceSLS、Object Storage Service和輕量訊息佇列（原 MNS）的資源資料同步被刪除，且不可恢複。
DeleteAggregateConfigRules	刪除規則	刪除指定帳號組內的規則。刪除規則後，其配置資訊不再保留。
DeleteCompliancePacks	刪除合規包	刪除指定合規包。刪除合規包後，該合規包的檢查結果和檢查報告也自動被刪除。
DeleteConfigDeliveryChannel	刪除投遞渠道	刪除投遞渠道後，投遞到Log ServiceSLS、Object Storage Service和輕量訊息佇列（原 MNS）的資源資料同步被刪除，且不可恢複。
DeleteConfigRules	刪除規則	刪除指定規則。刪除規則後，其配置資訊不再保留。
DescribeDiscoveredResourceBatch	批量擷取資源詳情	本介面用於批量擷取資源詳情。
DescribeIntegratedServiceStatus	查詢指定雲端服務的整合狀態	查詢使用者整合雲產品的授權狀態。
DetachAggregateConfigRuleToCompliancePack	將帳號組規則從合規包中移出	將指定帳號組規則從指定帳號組合規包中移出。
DetachConfigRuleToCompliancePack	將規則從合規包中移出	本介面用於從指定合規包中移出指定規則。
DryRunConfigRule	試運行事前合規預檢的規則	本介面用於試運行事前合規預檢的規則。
GenerateAggregateCompliancePackReport	產生帳號群組合規套件評估報告	為指定帳號群組內的指定合規套件產生評估報告。
GenerateAggregateConfigRulesReport	產生帳號組規則評估報告	為指定帳號組內規則列表中的規則產生評估報告。
GenerateAggregateResourceInventory	產生帳號組內全域資源下載清單	產生指定的帳號組內全域資源下載清單。
GenerateCompliancePackReport	產生合規包評估報告	產生合規包的評估報告。
GenerateConfigRulesReport	建置規則評估報告	建置規則的合規評估報告。
GenerateResourceInventory	產生全域資源下載清單	產生全域資源下載清單。
GetAdvancedSearchFile	查詢資源進階搜尋下載檔案	查詢當前帳號下最近一次產生的資源進階搜尋下載檔案（即擷取下載檔案地址）。
GetAggregateAccountComplianceByPack	查詢帳號組合規包中成員合規結果	查詢指定帳號組內指定合規包中成員帳號的合規結果。
GetAggregateAdvancedSearchFile	查詢帳號組內資源進階搜尋下載檔案	查詢指定帳號組下最近一次產生的資源進階搜尋下載檔案。
GetAggregateCompliancePack	查詢帳號組合規包詳情	查詢指定帳號組內合規包詳情。
GetAggregateCompliancePackReport	擷取帳號組合規包評估報告	擷取指定帳號組內指定合規包的評估報告。
GetAggregateComplianceSummary	查詢帳號組內合規統計概覽資訊	查詢指定帳號組的合規統計概覽資訊。
GetAggregateConfigDeliveryChannel	查詢指定帳號組內的指定投遞渠道資訊	查詢指定帳號組內的指定投遞渠道資訊。
GetAggregateConfigRule	查詢帳號組規則詳情	查詢指定帳號組內指定規則詳情。
GetAggregateConfigRuleComplianceByPack	查詢帳號組合規包規規則合規結果	查詢指定帳號組內指定合規包中規則的合規結果。
GetAggregateConfigRuleSummaryByRiskLevel	查詢帳號組規則風險等級維度合規概要	從指定帳號組內規則的風險等級維度查詢合規概要。
GetAggregateConfigRulesReport	下載帳號組規則評估報告	下載Excel格式的規則合規評估報告到本地，便於您雲下分配任務並跟進不合規資源配置的修改。
GetAggregateDiscoveredResource	獲取帳號群組內指定資源的資源詳情	獲取帳號群組內指定資源的資源詳情。
GetAggregateResourceComplianceByConfigRule	查詢帳號組規則合規評估結果維度合規概要	從指定帳號組內規則的合規評估結果維度查詢合規概要。
GetAggregateResourceComplianceByPack	查詢帳號組合規包資源合規統計	查詢指定帳號組內的指定合規包中資源的合規統計。
GetAggregateResourceComplianceGroupByRegion	查詢指定帳號組內規則的按資源所屬地區進行分組的評估結果	查詢指定帳號組內規則對資源的評估結果，評估結果按資源所屬地區進行分組展示。
GetAggregateResourceComplianceGroupByResourceType	擷取指定帳號組規則的按資源類型進行分組的評估結果	查詢指定帳號組內規則對資源的評估結果，評估結果按資源類型進行分組展示。
GetAggregateResourceComplianceTimeline	查詢帳號組資源合規檢測歷史	查詢指定帳號組內指定資源的合規檢測歷史。合規檢測歷史是資源的一組合規評估記錄，包括合規檢測歷史上的點和合規檢測歷史的內容。
GetAggregateResourceConfigurationTimeline	查詢帳號組資源配置變更歷史	查詢指定帳號組內指定資源的配置變更歷史。配置審計記錄資源的每一次配置變更和資源關係變更，並整理為配置變更歷史。您開通配置審計服務後，配置審計開始記錄資源的配置變更和資源關係變更歷史，並預設儲存10年。
GetAggregateResourceCountsGroupByRegion	從地區維度查詢指定帳號組內資源的統計結果	從地區維度查詢指定帳號組內資源的統計結果。
GetAggregateResourceCountsGroupByResourceType	從資源類型維度查詢指定帳號組內資源的統計結果	從資源類型維度查詢指定帳號組內資源的統計結果。
GetAggregateResourceInventory	查詢帳號組的全域資源下載清單資訊	擷取指定的帳號組內最近一次產生的全域資源下載清單資訊。
GetCompliancePack	查詢合規包詳情	查詢指定的合規包詳情。
GetCompliancePackReport	擷取合規包評估報告	擷取合規包的評估報告。
GetComplianceSummary	查詢合規統計概覽資訊	查詢當前帳號下合規統計概覽資訊。
GetConfigDeliveryChannel	查詢指定投遞渠道資訊	查詢指定投遞渠道資訊。
GetConfigRule	查詢規則詳情	查詢指定規則詳情。
GetConfigRuleComplianceByPack	查詢合規包中規則維度合規統計	查詢指定合規包中規則維度合規統計。
GetConfigRuleSummaryByRiskLevel	查詢規則風險等級維度合規概要	從規則的風險等級維度查詢合規概要。
GetConfigRulesReport	下載規則評估報告	下載Excel格式的規則合規評估報告到本地，便於您雲下分配任務並跟進不合規資源配置的修改。
GetDiscoveredResource	擷取指定資源的資源詳情	擷取指定資源的資源詳情。
GetDiscoveredResourceCountsGroupByRegion	從地區維度查詢資源的統計結果	從地區維度查詢資源的統計結果。
GetDiscoveredResourceCountsGroupByResourceType	從資源類型維度查詢資源的統計結果	從資源類型維度查詢資源的統計結果。
GetResourceComplianceByConfigRule	查詢規則合規評估結果維度合規概要	從規則的合規評估結果維度查詢合規概要。
GetResourceComplianceByPack	查詢合規包資源合規結果	查詢合規包中資源的合規結果。
GetResourceComplianceGroupByRegion	擷取指定規則的按資源所屬地區進行分組的評估結果	查詢規則對資源的評估結果，評估結果按資源所屬地區進行分組展示。
GetResourceComplianceGroupByResourceType	查詢指定規則的按資源類型進行分組的評估結果	查詢規則對資源的評估結果，評估結果按資源類型進行分組展示。
GetResourceComplianceTimeline	查詢資源合規檢測歷史	查詢指定資源的合規檢測歷史。合規檢測歷史是資源的一組合規評估記錄，包括合規檢測歷史上的點和合規檢測歷史的內容。
GetResourceConfigurationSample	擷取資源配置範例	本介面用於擷取指定資源類型的配置範例。
GetResourceConfigurationTimeline	查詢資源配置變更歷史	查詢指定資源的配置變更歷史。配置審計記錄資源的每一次配置變更和資源關係變更，並整理為配置變更歷史。您開通配置審計服務後，配置審計開始記錄資源的配置變更和資源關係變更歷史，並預設儲存10年。
GetResourceInventory	擷取全域資源下載清單資訊	擷取當前帳號最近一次產生的全域資源下載清單資訊。
GetResourceTypeProperties	擷取資源屬性描述	本介面用於擷取指定資源類型的屬性描述。
IgnoreAggregateEvaluationResults	忽略帳號組規則評估結果	忽略某個帳號組下某條規則對某些資源的評估結果。您還可以設定規則的忽略時間，當忽略到期後，自動回復顯示該規則對資源的檢測結果。
IgnoreEvaluationResults	忽略規則評估結果	忽略某條規則對某些資源的評估結果。您還可以設定規則的忽略時間，當忽略到期後，自動回復顯示該規則對資源的檢測結果。
ListAggregateCompliancePacks	查詢帳號組合規包列表	查詢指定帳號組內的合規包列表。
ListAggregateConfigDeliveryChannels	查詢指定帳號組內的所有投遞渠道資訊	查詢指定帳號組內的所有投遞渠道資訊。
ListAggregateConfigRuleEvaluationResults	查詢帳號組規則的評估結果	從規則維度查詢指定帳號組內規則對資源的評估結果。
ListAggregateConfigRuleEvaluationStatistics	查詢帳號組的合規統計趨勢	查詢目標帳號組的合規統計趨勢。
ListAggregateConfigRules	查詢帳號組的規則列表	查詢指定帳號組內的規則列表。
ListAggregateDiscoveredResources	擷取帳號組內資源清單	查詢指定帳號組內的資源清單。
ListAggregateRecommendManagedRules	列出推薦的帳號組託管規則	本介面用於擷取推薦的帳號組託管規則列表。
ListAggregateResourceEvaluationResults	查詢帳號組資源的評估結果	從資源維度查詢指定帳號組內規則對資源的評估結果。
ListAggregateResourceRelations	查詢帳號組內指定資源的相關資源清單	查詢帳號組內指定資源的相關資源清單。
ListAggregateResourcesByAdvancedSearch	應用進階搜尋查詢帳號組內資源清單	通過SQL的Select語句根據資源屬性中的欄位精確搜尋指定帳號組內的資源。
ListCompliancePacks	查詢合規包列表	查詢當前帳號的合規包列表。
ListConfigDeliveryChannels	查詢投遞渠道列表	查詢投遞渠道列表。
ListConfigRuleEvaluationResults	查詢規則評估結果	從規則維度查詢規則對資源的評估結果。
ListConfigRuleEvaluationStatistics	查詢當前帳號合規統計趨勢	查詢當前帳號的合規統計趨勢。
ListConfigRuleOperators	列出配置審計規則檢測支援的操作符	本介面用於擷取配置審計規則檢測支援的操作符列表。
ListConfigRules	查詢規則列表	查詢規則列表中的所有規則。
ListDiscoveredResources	擷取資源清單資訊	擷取當前帳號下跨地區彙總的資源清單資訊。
ListRecommendManagedRules	列出推薦的託管規則	本介面用於擷取推薦的託管規則列表。
ListResourceEvaluationResults	查詢資源評估結果	從資源維度查詢規則對資源的評估結果。
ListResourceRelations	查詢指定資源的相關資源清單	查詢指定資源的相關資源清單。
ListResourcesByAdvancedSearch	應用進階搜尋查詢資源清單	通過SQL的Select語句根據資源屬性中的欄位精確搜尋資源。
ListTagResources	查詢指定資源綁定的標籤	查詢配置審計中資源綁定的標籤。
RevertAggregateEvaluationResults	恢複已忽略帳號組規則的評估結果	恢複已忽略帳號組內某條規則對某些資源的評估結果後，繼續顯示該規則對資源的評估結果。
RevertEvaluationResults	恢複已忽略規則的評估結果	恢複已忽略的某條規則對某些資源的評估結果後，繼續顯示該規則對資源的評估結果。
StartAggregateConfigRuleEvaluation	重新審計帳號組規則或合規包	重新審計指定帳號組內的某條規則或某個合規包中的所有規則。
StartConfigRuleEvaluation	重新審計規則或合規包	重新審計某條規則或某個合規包中的所有規則。
StartConfigRuleEvaluationByResource	單資源維度執行評估	觸發單資源重新評估。
TagResources	綁定標籤	為配置審計的規則、帳號組和合規包綁定標籤。
UntagResources	解除綁定標籤	為配置審計中的資源解除綁定標籤。
UpdateAggregateCompliancePack	修改帳號組合規包資訊	修改指定帳號組內的合規包資訊。
UpdateAggregateConfigDeliveryChannel	修改指定帳號組內的投遞渠道	修改指定帳號組內的投遞渠道。
UpdateAggregateConfigRule	修改帳號組規則	修改指定帳號組內規則的描述資訊、規則入參和風險等級等。
UpdateCompliancePack	修改合規包資訊	修改當前帳號指定合規包的資訊。
UpdateConfigDeliveryChannel	修改投遞渠道	本介面用於當前帳號修改投遞渠道。
UpdateConfigRule	修改規則	修改規則的描述資訊、規則入參和風險等級等。