全部產品
Search
文件中心

Service Catalog:整合概覽

更新時間:Jul 13, 2024

服務類別目錄除提供可視化Operations 主控台外,還提供OpenAPI線上調試、阿里雲SDK等調用方式。為提升您使用服務類別目錄的開發效率,建議您按需選擇合適的操作和整合方式。

OpenAPI介紹

為了能夠讓開發人員快速高效地學習和使用雲產品OpenAPI,阿里雲為使用者提供OpenAPI門戶網站。它是一款集OpenAPI智能搜尋、文檔、線上調試、SDK擷取、CodeSample、調用出錯診斷、調用統計為一體的產品。您可以在OpenAPI門戶中調用阿里雲各雲產品開放的OpenAPI,查看OpenAPI請求和返回結果。此外,OpenAPI門戶會自動產生相應的SDK調用樣本,協助您快速使用阿里雲產品。更多資訊,請參見什麼是OpenAPI

版本說明

阿里雲OpenAPI通過版本號碼管控各時期雲產品大版本的API列表,例如服務類別目錄目前支援2021-09-01版本的API列表,2021-09-01代表的是API版本號碼而非時間概念,所展示的都是最新的API公開資料,並非自2021-09-01之後就未更新。

版本號碼

說明

2021-09-01

推薦使用

線上調試

服務類別目錄在OpenAPI門戶提供API調試等功能。在調用前,您需要瞭解服務類別目錄提供的版本、存取點說明、整合方式等資訊。

image.png

調試入口

調試API入口為:服務類別目錄API調試列表

存取點說明

根據相關資源所在地區,選擇對應的服務存取點地址,以獲得最低延遲。例如華東1(杭州)的服務類別目錄公網接入地址為servicecatalog.cn-hangzhou.aliyuncs.com,VPC接入地址為servicecatalog-vpc.cn-hangzhou.aliyuncs.com

  • 公網接入地址在全球都可訪問。

  • VPC接入地址只有在阿里雲對應的地區內,且是VPC網路類型才可訪問。VPC地址的優勢:

    • 高安全性:VPC服務地址只能在VPC內部訪問,提供更高的安全性和隱私性。

    • 更快的響應速度:由於VPC服務地址在VPC內部網路中運行,其響應速度通常比公網服務更快,且可以避免公網延遲和頻寬節流設定等問題。

    • 更低的成本:VPC服務地址可以使用內部網路通訊。

更多資訊,請參見服務存取點

使用者身份

您阿里雲帳號登入OpenAPI網站後,OpenAPI預設使用您的阿里雲帳號進行線上OpenAPI調試。阿里雲帳號擁有所有API的存取權限,風險很高。強烈建議您建立並使用RAM使用者進行API訪問或日常營運。請根據業務的實際情況按需分配許可權後進行介面調用。RAM使用者需具備操作服務類別目錄資源的許可權。具體操作,請參見使用RAM進行存取控制

使用者身份

支援情況

阿里雲帳號

支援

RAM 使用者(推薦)

支援

RAM角色(推薦)

支援

更多資訊

整合方式

說明

SDK是最易於整合,且支援度最好的OpenAPI調用方式,推薦您選擇使用SDK。

整合方式總覽

調用方式

支援情況

阿里雲SDK(推薦)

支援

阿里雲CLI

不支援

Resource Orchestration Service

不支援

自訂封裝API調用

支援

  • 阿里雲SDK

    • 阿里雲為開發人員提供了多種程式設計語言(Java、C#、Go、Python、Node.js/TypeScript、PHP、C++ 等)的SDK。開發人員只需要整合SDK,通過SDK暴露的方法直接調用OpenAPI 。SDK統一封裝了簽名邏輯、逾時機制、重試機制,並根據文檔返回結構化Response對象,易於開發。更多關於阿里雲SDK的介紹,請參見阿里雲SDK

    • 支援在OpenAPI通過阿里雲SDK調用服務類別目錄。支援語言及依賴安裝方法請參見服務類別目錄SDK

  • 阿里雲CLI

    • 阿里雲命令列工具可以幫您在使用命令列終端時,使用aliyun命令與阿里雲服務進行互動,管理雲端服務資源。有關阿里雲CLI的更多詳細資料,請參見什麼是阿里雲CLI

    • 暫不支援使用阿里雲CLI調用服務類別目錄。

  • Resource Orchestration Service

    • Resource Orchestration Service服務ROS(Resource Orchestration Service)是阿里雲提供的一項簡化雲端運算資源管理的服務。開發人員和管理員可以編寫模板,在模板中定義所需的阿里雲資源(例如:ECS 執行個體、RDS 資料庫執行個體)、資源間的依賴關係等。ROS 的編排引擎將根據模板自動完成所有資源的建立和配置,實現自動化部署及營運。更多詳情,請參見什麼是Resource Orchestration Service服務

    • 暫不支援使用Resource Orchestration Service調用服務類別目錄。

注意事項

如果調用服務類別目錄API後返回錯誤,您需要根據返回的錯誤碼提示檢查傳入的請求參數及其取值是否正確。

您也可以記錄下調用返回的RequestID或SDK報錯資訊,通過阿里雲OpenAPI診斷平台進行自助診斷。

相關文檔

  • 服務類別目錄基於阿里雲IaC(基礎設施即代碼)能力,構建自訂的阿里雲IT服務列表,並可設定約束條件符合組織治理要求,從而降低企業業務上雲時選用產品的難度,提高IT服務交付效率。瞭解更多產品資訊,請參見什麼是服務類別目錄

  • 服務類別目錄支援的SDK語言,請參見SDK概覽