OpenAPI介紹

為了讓開發者能夠快速高效地學習和使用云產品OpenAPI，阿里云為用戶提供OpenAPI網站。它是一款集OpenAPI智能搜索、文檔、在線調試、SDK獲取、CodeSample、調用出錯診斷、調用統計為一體的產品。您可以在OpenAPI門戶中調用阿里云各云產品開放的OpenAPI，查看OpenAPI請求和返回結果。此外，OpenAPI門戶會自動生成相應的SDK調用示例，幫助您快速使用阿里云產品。輕量應用服務器提供實例、磁盤、鏡像、密鑰對、防火墻等OpenAPI，您可通過使用OpenAPI實現對產品云資源的管控。更多信息，請參見什么是OpenAPI。

集成方式

集成方式總覽

• 阿里云 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調用輕量應用服務器，若您有使用CLI的需求，請提交工單反饋。

• 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診斷平臺進行自助診斷。

常見問題

• 如果您想了解輕量應用服務器產品，請參見什么是輕量應用服務器。

• 了解更多產品支持的特性，請參見輕量應用服務器支持的功能特性清單。