整合概覽

OpenAPI介紹

阿里雲OpenAPI是一系列介面，讓開發人員能通過代碼編程方式訪問和管理阿里雲服務，提供自動化、定製化解決方案。為了能夠讓開發人員快速高效地學習和使用雲產品的OpenAPI，阿里雲專為開發人員提供了OpenAPI門戶，它整合了智能OpenAPI搜尋、詳盡文檔查閱、即時線上調試、SDK便捷擷取、程式碼範例引用、錯誤診斷工具、調用統計分析等多項強大功能。通過OpenAPI門戶，您能夠無縫對接並調用阿里雲全方位雲產品的OpenAPI介面，直觀審查API請求及其響應詳情，加速您的開發進程。更多資訊，請參見什麼是OpenAPI。

版本說明

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

版本號碼	說明
2018-01-20	推薦

線上調試

阿里雲物聯網平台支援在阿里雲OpenAPI門戶進行API調試，在調試之前，您需要提前瞭解API版本、存取點說明、API參數等資訊。

在 OpenAPI Explorer 中選擇 QueryProduct 介面，將服務地址設定為華北2（北京），並填寫請求參數 IotInstanceId（執行個體 ID，非必填）和 ProductKey（要查詢的產品 ProductKey，必填），然後單擊發起調用。

調試入口

API調試入口：。

存取點說明

服務存取點是訪問阿里雲服務的進入點，分為公網接入地址和VPC接入地址。

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

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

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

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

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

在選擇存取點時，一般選擇距離您的使用者或業務最近的存取點可以減少網路延遲，提高資料轉送速度和應用回應時間。例如，如果您的主要使用者群體位於杭州，那麼選擇杭州地區的存取點會更加合適。

阿里雲物聯網平台的存取點請在Regions中查看。

使用者身份

您阿里雲帳號登入OpenAPI門戶後，OpenAPI預設使用您的阿里雲帳號進行線上OpenAPI調試。阿里雲帳號擁有所有API的存取權限，風險很高，建議您建立並使用RAM使用者進行API訪問或日常營運。請根據業務的實際情況按需分配許可權後進行介面調用。RAM使用者需具備物聯網平台的許可權，具體操作，請參見物聯網平台RAM授權說明

使用者身份	支援情況
阿里雲帳號	支援
RAM使用者（推薦）	支援
RAM角色（推薦）	支援

更多資訊

• 身份、憑據與授權

• 流量控制與配額管理

整合方式

整合方式	支援情況
阿里雲SDK	支援
阿里雲CLI	支援
Terraform	部分支援
Resource Orchestration Service	部分支援
自訂封裝API調用	支援

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

  • 支援使用Terraform。支援的資源和資料資源清單：

    類型	清單	說明
    Resources	alicloud_iot_device_group	提供了一個物聯網裝置分組資源。
    Data Sources	alicloud_iot_device_groups	此資料來源提供了當前阿里雲使用者的所有物聯網裝置分組資訊。
    	alicloud_iot_service	使用此資料來源可以自動開啟物聯網服務。如果服務已經開啟，則會返回“已開啟”狀態。

• Resource Orchestration Service

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

  • 支援使用Resource Orchestration Service。支援的資源類型：

    資源類型	說明
    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 問題診斷進行自助診斷。