OpenAPI介紹

阿里云OpenAPI是一系列接口，讓開發者能通過代碼編程方式訪問和管理阿里云服務，提供自動化、定制化解決方案。為了能夠讓開發者快速高效地學習和使用云產品的OpenAPI，阿里云專為開發者提供了OpenAPI門戶，它集成了智能OpenAPI搜索、詳盡文檔查閱、即時在線調試、SDK便捷獲取、代碼示例引用、錯誤診斷工具、調用統計分析等多項強大功能。通過OpenAPI門戶，您能夠無縫對接并調用阿里云全方位云產品的OpenAPI接口，直觀審查API請求及其響應詳情，加速您的開發進程。更多信息，請參見什么是 OpenAPI。

版本說明

在線調試2018-01-20版本的API列表，2018-01-20代表的是API版本號而非時間概念，所展示的都是最新的API公開數據，并非自2018-01-20之后就未更新。如何查看API版本，請參見查看API版本。

在線調試

阿里云物聯網平臺支持在阿里云OpenAPI門戶進行API調試，在調試之前，您需要提前了解API版本、接入點說明、API參數等信息。

調試入口

API調試入口：物聯網平臺API調試。

接入點說明

服務接入點是訪問阿里云服務的入口點，分為公網接入地址和VPC接入地址。

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

• VPC接入地址只有在阿里云對應的地域內，且是VPC網絡類型才可訪問。VPC地址的好處：

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

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

  • 更低的成本：VPC服務地址可以使用內部網絡通信，減少對外部流量的依賴，可以有效降低因使用公網帶寬而產生的費用。

在選擇接入點時，一般選擇距離您的用戶或業務最近的接入點可以減少網絡延遲，提高數據傳輸速度和應用響應時間。例如，如果您的主要用戶群體位于杭州，那么選擇杭州地區的接入點會更加合適。

阿里云物聯網平臺的接入點請在服務區域列表中查看。

用戶身份

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

更多信息

• 身份、憑據與授權

• 流量控制與配額管理

集成方式

• 阿里云SDK

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

  • 支持使用阿里云物聯網平臺SDK調用OpenAPI，物聯網平臺SDK支持的語言及依賴安裝方法請參考物聯網平臺SDK。

• 阿里云CLI

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

  • 支持使用阿里云CLI。如何獲取和使用阿里云CLI命令，請參見CLI 指南。

• Terraform

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

  • 支持使用Terraform。支持的資源和數據資源清單：

    類型	清單	說明
    Resources	alicloud_iot_device_group	提供了一個物聯網設備分組資源。
    Data Sources	alicloud_iot_device_groups	此數據源提供了當前阿里云用戶的所有物聯網設備分組信息。
    	alicloud_iot_service	使用此數據源可以自動開啟物聯網服務。如果服務已經開啟，則會返回“已開啟”狀態。

• 資源編排ROS

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

  • 支持使用資源編排。支持的資源類型：

    資源類型	說明
    ALIYUN::IOT::Device	注冊設備。
    ALIYUN::IOT::DeviceGroup	創建分組。
    ALIYUN::IOT::Product	創建產品。
    ALIYUN::IOT::ProductTopic	為指定產品創建自定義Topic。
    ALIYUN::IOT::Rule	為指定Topic新建一個規則。
    ALIYUN::IOT::RuleAction	在指定的規則下創建一個規則動作。

• 自定義封裝API調用

  • 原生HTTP調用需要您自己實現簽名算法，并構建自定義請求，發起HTTP調用。有關簽名機制的更多詳細信息，請參見阿里云物聯網平臺API參考和V3版本請求體&簽名機制。

注意事項

• 單個阿里云賬號調用不同API的每秒請求數（QPS）不同，詳情請參見各API文檔的QPS限制。

  說明

  單個阿里云賬號下的所有RAM用戶共享該阿里云賬號的QPS配額。

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

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