全部產品
Search
文件中心

:調用API

更新時間:Jun 30, 2024

本文主要介紹調用物聯網平台雲端API的請求結構和請求樣本。

請求結構

您可以通過發送HTTP或HTTPS請求調用物聯網平台API。

請求結構如下:

http://Endpoint/?Action=****&Parameters
參數說明
Endpoint調用雲端服務的接入地址。物聯網平台的接入地址格式:iot.${RegionId}.aliyuncs.com。其中,變數${RegionId}需替換為您的物聯網平台服務的地區代碼。阿里雲地區代碼,請參見支援的地區
Action要執行的操作,即雲端API的介面名稱。例如,調用Pub介面向指定Topic發布訊息,Action對應的值就是Pub,即Action=Pub
Parameters調用API的請求參數。每個參數之間用(&)符號分隔。

請求參數由公用請求參數和API自訂請求參數組成。公用參數中包含API版本號碼、身分識別驗證等資訊。

請求樣本

下文以調用2018-01-20版本的Pub介面向指定Topic發布訊息為例:
說明 本文檔樣本均使用華東2(上海)地區的接入地址。為了便於閱讀,程式碼範例均做了格式化處理。請求參數說明,請參見公用參數Pub
https://iot.cn-shanghai.aliyuncs.com/?Action=Pub
&Format=XML
&Version=2018-01-20
&Signature=Pc5WB8gok***1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=LTAI4***iW5j3
&Timestamp=2017-07-19T12:00:00Z
&RegionId=cn-shanghai
...

API線上調試

阿里雲OpenAPI開發人員門戶提供OpenAPI Explorer。在API調試頁面,您可以快速檢索和體驗調用API。系統會根據您輸入的參數同步產生各語言SDK的程式碼範例。各語言SDK程式碼範例顯示在頁面右側SDK樣本頁簽下供您參考。在調用結果頁簽下,可查看API調用的真實請求URL和JSON格式的返回結果。

OpenAPI