API Gateway：整合概覽

OpenAPI介紹

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

版本說明

阿里雲OpenAPI通過版本號碼管控各時期雲產品大版本的API列表，例如API Gateway目前支援2016-07-14版本的API列表，2016-07-14代表的是API版本號碼而非時間概念，所展示的都是最新的API公開資料，並非自2016-07-14之後就未更新。

線上調試

API Gateway在OpenAPI門戶提供API調試功能。在調用前，您需要瞭解API Gateway提供的版本、存取點、介面風格、調用方式等資訊。

調試入口

調試API入口為：API Gateway調試-入口。

存取點說明

根據相關資源所在地區，選擇對應的服務存取點地址，以獲得最低延遲。例如華東1（杭州）公網接入地址為：apigateway.cn-hangzhou.aliyuncs.com，VPC接入地址為：apigateway-vpc.cn-hangzhou-finance.aliyuncs.com。

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

• VPC（Virtual Private Cloud）隔離了虛擬網路，每個VPC對應一個虛擬化網路。VPC地址的優勢：

  • 高安全性：VPC接入地址只能在VPC內部訪問，提供更高的安全性和隱私性。

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

  • 更低的成本：VPC接入地址可以使用內部網路通訊。

介面風格

RPC風格。

使用者身份

當您登入OpenAPI網站後，OpenAPI預設使用您所登入的帳號進行線上OpenAPI調試。由於阿里雲帳號擁有所有API的存取權限，存在較高風險，因此不建議您使用阿里雲帳號線上調試API。強烈建議您建立並使用RAM使用者進行API訪問或日常營運。請根據業務的實際情況按需分配許可權後進行API調用。RAM使用者需具備操作雲備份資源的許可權。具體操作，請參見建立RAM使用者進行雲備份操作。

更多資訊

• 身份、憑據與授權

• 流量控制與配額管理

整合方式

API Gateway提供了阿里雲SDK、阿里雲CLI、Resource Orchestration Service、Terraform和自訂封裝這幾種整合方式，您可以根據業務的實際需要進行選擇。

• 阿里雲SDK

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

  • 支援使用網域名稱服務 (DNS)SDK調用OpenAPI，支援語言及依賴的安裝方法請參見Java SDK調用樣本。

• 阿里雲CLI

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

• Resource Orchestration Service

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

• Terraform

  Terraform 是一種開源工具，用於安全高效地預覽，配置和管理雲基礎架構和資源。它與阿里雲的Resource Orchestration Service服務的運行機制類似，通過將模板轉化為內部資料後完成 OpenAPI 呼叫。更多詳情，請參見什麼是 Terraform。

• 自訂封裝API調用

  原生HTTP調用需要您自己實現簽名演算法，並構建自訂請求，發起HTTP調用。有關簽名機制的更多詳細資料，請參見V3版本請求體&簽名機制。

注意事項

• 如果調用API GatewayAPI後返回錯誤，您需要根據返回的錯誤碼提示檢查傳入的請求參數及其取值是否正確。。

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