OpenAPI介紹

為了能夠讓開發者快速高效地學習和使用云產品OpenAPI，阿里云為用戶提供OpenAPI網站。它是一款集OpenAPI智能搜索、文檔、在線調試、SDK獲取、CodeSample、調用出錯診斷、調用統計為一體的產品。您可以在OpenAPI門戶中調用阿里云各云產品開放的OpenAPI，查看OpenAPI請求和返回結果。此外，OpenAPI門戶會自動生成相應的SDK調用示例，幫助您快速使用阿里云產品。更多信息，請參見什么是OpenAPI。

版本說明

阿里云OpenAPI通過版本號管控各時期云產品大版本的API。例如：RDS目前支持2014-08-15版本的API，2014-08-15代表的是API版本號而非時間概念，所展示的都是最新的API公開數據，并非自2014-08-15之后就未更新。

在線調試

RDS在OpenAPI門戶提供API調試等功能。在調用前，您需要了解RDS提供的版本、接入點說明、集成方式等信息。

調試入口

調試API入口為：調試入口

接入點說明

根據實例所在的地域，選擇對應的服務接入點地址，以獲得最低延遲。例如華北3（張家口），公網接入地址為rds.cn-zhangjiakou.aliyuncs.com，VPC接入地址為rds-vpc.cn-zhangjiakou.aliyuncs.com。

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

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

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

  • 更快的響應速度：由于VPC接入地址在VPC內部網絡中運行，其響應速度通常比公網接入地址更快，并且可以避免公網延遲和帶寬限制等問題。

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

更多信息請參見服務接入點。

支持的用戶身份

您阿里云賬號登錄OpenAPI網站后，默認使用您的阿里云賬號進行在線OpenAPI調試。阿里云賬號擁有所有API的訪問權限，風險很高。強烈建議您創建并使用RAM用戶進行API訪問或日常運維。請根據業務的實際情況按需分配權限后進行接口調用。RAM用戶需具備操作RDS資源的權限。具體操作，請參見RAM授權訪問RDS實例。

更多信息

• 身份、憑據與授權

• 流量控制與配額管理

集成方式

RDS提供阿里云SDK、Terraform、資源編排和自定義封裝這幾種集成方式，您可以根據業務的實際需要進行選擇。

• 阿里云 SDK

  • 阿里云為開發者提供了多種編程語言（Java、C#、Go、Python、Node.js/TypeScript、PHP、C++ 等）的SDK。開發者只需要集成SDK，通過SDK暴露的方法直接調用OpenAPI。SDK統一封裝了簽名邏輯、超時機制、重試機制，并根據文檔返回結構化Response對象，易于開發。更多關于阿里云SDK的介紹，請參見阿里云SDK。

  • 支持通過阿里云SDK調用RDS的OpenAPI。支持語言及依賴安裝方法請參見云數據庫RDS SDK。

• 阿里云CLI

  • 阿里云命令行工具可以幫您在使用命令行終端時，使用aliyun命令與阿里云服務進行交互，管理云服務資源。有關阿里云CLI的更多詳細信息，請參見什么是阿里云CLI。

  • 支持通過阿里云CLI調用RDS的OpenAPI。使用方法請參見生成命令。

• Terraform

  • Terraform 是一種開源工具，用于安全高效地預覽，配置和管理云基礎架構和資源。它與阿里云的資源編排服務的運行機制類似，通過將模板轉化為內部數據后完成 OpenAPI 調用。更多詳情，請參見什么是Terraform。

  • 支持通過Terraform調用RDS的OpenAPI。支持的資源和數據清單請參見Terraform支持的RDS資源。

• 資源編排ROS

  • 資源編排服務ROS（Resource Orchestration Service）是阿里云提供的一項簡化云計算資源管理的服務。開發者和管理員可以編寫模板，在模板中定義所需的阿里云資源（例如：ECS 實例、RDS 數據庫實例）、資源間的依賴關系等。ROS 的編排引擎將根據模板自動完成所有資源的創建和配置，實現自動化部署及運維。更多詳情，請參見什么是資源編排服務。

  • 支持通過資源編排ROS調用RDS的OpenAPI。支持的資源和數據清單請參見ROS支持的RDS資源。

• 自定義封裝API調用

  原生HTTP調用需要您自己實現簽名算法，并構建自定義請求，發起HTTP調用。有關簽名機制的更多詳細信息，請參見API概覽和V3版本請求體&簽名機制。

注意事項

如果調用RDS API后返回錯誤，您需要根據返回的錯誤碼提示檢查傳入的請求參數及其取值是否正確。更多信息，請參見公共錯誤碼。

您也可以記錄下調用返回的RequestID或SDK報錯信息，通過阿里云OpenAPI診斷平臺進行自助診斷。