配置審計提供可視化操作控制臺,還提供OpenAPI在線調試、阿里云SDK、阿里云CLI、Terraform等調用方式。為提升您使用配置審計的開發效率,建議您按需選擇合適的操作和集成方式。
OpenAPI介紹
為了能夠讓開發者快速高效地學習和使用云產品OpenAPI,阿里云為用戶提供OpenAPI網站。它是一款集OpenAPI智能搜索、文檔、在線調試、SDK獲取、CodeSample、調用出錯診斷、調用統計為一體的產品。您可以在OpenAPI門戶中調用阿里云各云產品開放的OpenAPI,查看OpenAPI請求和返回結果。此外,OpenAPI門戶會自動生成相應的SDK調用示例,幫助您快速使用阿里云產品。更多信息,請參見什么是OpenAPI。
版本說明
阿里云OpenAPI通過版本號管控各時期云產品大版本的API列表,例如配置審計目前支持2020-09-07
版本的API列表,2020-09-07
代表的是API版本號而非時間概念,所展示的都是最新的API公開數據,并非自2020-09-07
之后就未更新。
版本號 | 說明 |
推薦使用 |
在線調試
配置審計在OpenAPI門戶提供API調試等功能。在調用前,您需要了解配置審計提供的版本、接入點說明、集成方式等信息。
調試入口
調試API入口為:配置審計API調試列表
接入點說明
配置審計的接入地址(Endpoint)與地域無關,完全取決于您當前賬號的歸屬站點,具體如下表所示。
賬號歸屬站點 | 地域名稱 | 地域ID | 公網接入地址 | VPC接入地址 |
中國站 | 華東2(上海) | cn-shanghai | config.cn-shanghai.aliyuncs.com | config-vpc.cn-shanghai.aliyuncs.com |
International | 新加坡 | ap-southeast-1 | config.ap-southeast-1.aliyuncs.com | config-vpc.ap-southeast-1.aliyuncs.com |
用戶身份
您使用阿里云賬號登錄OpenAPI網站后,OpenAPI默認使用您的阿里云賬號進行在線OpenAPI調試。阿里云賬號擁有所有API的訪問權限,風險很高。強烈建議您創建并使用RAM用戶進行API訪問或日常運維。請根據業務的實際情況按需分配權限后進行接口調用。RAM用戶需具備操作配置審計資源的權限。具體操作,請參見使用RAM進行訪問控制。
用戶身份 | 支持情況 |
支持 | |
RAM 用戶(推薦) | 支持 |
RAM角色(推薦) | 支持 |
更多信息
集成方式
SDK是最易于集成,且支持度最好的OpenAPI調用方式,推薦您選擇使用SDK。
集成方式總覽
調用方式 | 支持情況 |
阿里云SDK(推薦) | 支持 |
支持 | |
支持 | |
不支持 | |
支持 |
Terraform
Terraform 是一種開源工具,用于安全高效地預覽,配置和管理云基礎架構和資源。它與阿里云的資源編排服務的運行機制類似,通過將模板轉化為內部數據后完成 OpenAPI 調用。更多詳情,請參見什么是Terraform。
支持Terraform編排和使用配置審計,支持部分普通資源和數據資源清單,請參見配置審計Terraform資源和數據源。
快速使用Terraform編排配置審計,請參見Terraform集成示例。
資源編排ROS
資源編排服務ROS(Resource Orchestration Service)是阿里云提供的一項簡化云計算資源管理的服務。開發者和管理員可以編寫模板,在模板中定義所需的阿里云資源(例如:ECS 實例、RDS 數據庫實例)、資源間的依賴關系等。ROS 的編排引擎將根據模板自動完成所有資源的創建和配置,實現自動化部署及運維。更多詳情,請參見什么是資源編排服務。
暫不支持使用資源編排服務ROS調用配置審計。
自定義封裝API調用
原生HTTP調用需要您自己實現簽名算法,并構建自定義請求,發起HTTP調用。有關簽名機制的更多詳細信息,請參見配置審計API概覽和V3版本請求體&簽名機制。
注意事項
如果調用配置審計API后返回錯誤,您需要根據返回的錯誤碼提示檢查傳入的請求參數及其取值是否正確。
您也可以記錄下調用返回的RequestID或SDK報錯信息,通過阿里云OpenAPI診斷平臺進行自助診斷。