集成概覽
云SSO提供可視化操作控制臺,還提供OpenAPI在線調(diào)試、阿里云SDK、阿里云CLI、Terraform等調(diào)用方式。為提升您使用云SSO的開發(fā)效率,建議您按需選擇合適的操作和集成方式。
OpenAPI介紹
為了讓開發(fā)者能夠快速高效地學習和使用云產(chǎn)品OpenAPI,阿里云為用戶提供OpenAPI網(wǎng)站。它是一款集OpenAPI智能搜索、文檔、在線調(diào)試、SDK獲取、CodeSample、調(diào)用出錯診斷、調(diào)用統(tǒng)計為一體的產(chǎn)品。您可以在OpenAPI門戶中調(diào)用阿里云各云產(chǎn)品開放的OpenAPI,查看OpenAPI請求和返回結(jié)果。此外,OpenAPI門戶會自動生成相應(yīng)的SDK調(diào)用示例,幫助您快速使用阿里云產(chǎn)品。更多信息,請參見什么是OpenAPI。
版本說明
阿里云OpenAPI通過版本號管控各時期云產(chǎn)品大版本的API列表,例如云SSO目前支持2021-05-15
版本的API列表,2021-05-15
代表的是API版本號而非時間概念,所展示的都是最新的API公開數(shù)據(jù),并非自2021-05-15
之后就未更新。
版本號 | 說明 |
推薦使用 |
在線調(diào)試
云SSO在OpenAPI門戶提供API調(diào)試等功能。在調(diào)用前,您需要了解云SSO提供的版本、接入點說明、集成方式等信息。
調(diào)試入口
調(diào)試API入口為:云SSO API調(diào)試列表
接入點說明
根據(jù)相關(guān)資源所在地域,選擇對應(yīng)的服務(wù)接入點地址,以獲得最低延遲。例如華東2(上海)的云SSO公網(wǎng)接入地址為cloudsso.cn-shanghai.aliyuncs.com
,VPC接入地址為cloudsso-vpc.cn-shanghai.aliyuncs.com
。
公網(wǎng)接入地址在全球都可訪問。
VPC接入地址只有在阿里云對應(yīng)的地域內(nèi),且是VPC網(wǎng)絡(luò)類型才可訪問。VPC地址的優(yōu)勢:
高安全性:VPC服務(wù)地址只能在VPC內(nèi)部訪問,提供更高的安全性和隱私性。
更快的響應(yīng)速度:由于VPC服務(wù)地址在VPC內(nèi)部網(wǎng)絡(luò)中運行,其響應(yīng)速度通常比公網(wǎng)服務(wù)更快,且可以避免公網(wǎng)延遲和帶寬限制等問題。
更低的成本:VPC服務(wù)地址可以使用內(nèi)部網(wǎng)絡(luò)通信。
更多信息,請參見服務(wù)接入點。
用戶身份
您阿里云賬號登錄OpenAPI網(wǎng)站后,OpenAPI默認使用您的阿里云賬號進行在線OpenAPI調(diào)試。阿里云賬號擁有所有API的訪問權(quán)限,風險很高。強烈建議您創(chuàng)建并使用RAM用戶進行API訪問或日常運維。請根據(jù)業(yè)務(wù)的實際情況按需分配權(quán)限后進行接口調(diào)用。RAM用戶需具備操作云SSO資源的權(quán)限。具體操作,請參見使用RAM進行訪問控制。
用戶身份 | 支持情況 |
支持 | |
RAM 用戶(推薦) | 支持 |
RAM角色(推薦) | 支持 |
更多信息
集成方式
SDK是最易于集成,且支持度最好的OpenAPI調(diào)用方式,推薦您選擇使用SDK。
集成方式總覽
調(diào)用方式 | 支持情況 |
阿里云SDK(推薦) | 支持 |
支持 | |
支持 | |
不支持 | |
支持 |
Terraform
Terraform 是一種開源工具,用于安全高效地預覽,配置和管理云基礎(chǔ)架構(gòu)和資源。它與阿里云的資源編排服務(wù)的運行機制類似,通過將模板轉(zhuǎn)化為內(nèi)部數(shù)據(jù)后完成OpenAPI調(diào)用。更多詳情,請參見什么是Terraform。
支持Terraform編排和使用云SSO,支持部分普通資源和數(shù)據(jù)資源清單,請參見云SSO Terraform資源和數(shù)據(jù)源。
快速使用Terraform編排云SSO,請參見Terraform集成示例。
資源編排ROS
資源編排服務(wù)ROS(Resource Orchestration Service)是阿里云提供的一項簡化云計算資源管理的服務(wù)。開發(fā)者和管理員可以編寫模板,在模板中定義所需的阿里云資源(例如:ECS實例、RDS數(shù)據(jù)庫實例)、資源間的依賴關(guān)系等。ROS的編排引擎將根據(jù)模板自動完成所有資源的創(chuàng)建和配置,實現(xiàn)自動化部署及運維。更多詳情,請參見什么是資源編排服務(wù)。
暫不支持使用資源編排ROS調(diào)用云SSO。
自定義封裝API調(diào)用
原生HTTP調(diào)用需要您自己實現(xiàn)簽名算法,并構(gòu)建自定義請求,發(fā)起HTTP調(diào)用。有關(guān)簽名機制的更多詳細信息,請參見云SSO API概覽和V3版本請求體&簽名機制。
注意事項
如果調(diào)用云SSO API后返回錯誤,您需要根據(jù)返回的錯誤碼提示檢查傳入的請求參數(shù)及其取值是否正確。
您也可以記錄下調(diào)用返回的RequestID或SDK報錯信息,通過阿里云OpenAPI診斷平臺進行自助診斷。