調用該接口為指定設備創建安全隧道。
使用說明
調用本接口創建安全隧道成功后，該安全隧道狀態默認為已打開。
- 創建24小時后，安全隧道狀態自動更新為已關閉。
- 創建30天后，安全隧道會被系統自動刪除。
使用限制
- 單個設備最多包含10個安全隧道。
- 單個實例下最多包含1,000個安全隧道。
QPS限制
單個阿里云賬號調用該接口的每秒請求數（QPS）最大限制為5。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
| 名稱 | 類型 | 是否必選 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | CreateDeviceTunnel |
系統規定參數。取值：CreateDeviceTunnel。 |
| IotId | String | 否 | Q7uOhVRdZRRlDnTLv***00100 |
指定設備的設備ID。 注意 如果傳入該參數，則無需傳入ProductKey和DeviceName。IotId作為設備唯一標識符，和ProductKey與DeviceName的組合是一一對應的關系。如果您同時傳入IotId和ProductKey與DeviceName的組合，則以IotId為準。
|
| Description | String | 否 | 用于遠程登錄到攝像頭。 |
安全隧道的描述信息。內容長度不超過1024個字符。 |
| Udi | String | 否 | reboot |
推送給設備的自定義信息，數據格式自定義，長度不超過4096個字符。 會在通知設備創建安全隧道時發送給設備。 |
| ProductKey | String | 否 | a1BwAGV*** |
指定設備所屬產品的ProductKey。 注意 如果傳入該參數，需同時傳入DeviceName。
|
| DeviceName | String | 否 | light |
指定設備的設備名稱。 注意 如果傳入該參數，需同時傳入ProductKey。
|
| IotInstanceId | String | 否 | iot-***-v64*** |
實例ID。您可在物聯網平臺控制臺的實例概覽頁面，查看當前實例的ID。 注意
實例的更多信息，請參見實例概述。 |
調用API時，除了本文介紹的該API的特有請求參數，還需傳入公共請求參數。公共請求參數說明，請參見公共參數文檔。
返回數據
| 名稱 | 類型 | 示例值 | 描述 |
|---|---|---|---|
| Code | String | iot.system.SystemException |
調用失敗時，返回的錯誤碼。更多信息，請參見錯誤碼。 |
| Data | Struct |
調用成功時，返回安全隧道的基本信息。 |
|
| SourceAccessToken | String | 521c43e4-a6da-*** |
通過安全隧道訪問對應設備的認證Token，用于WebSocket建連的認證階段，詳細說明，請參見安全隧道使用流程。 |
| SourceURI | String | wss://secure-tunnel-ws.iot.aliyun.test/tunnel/1834248a-37b7-4fd2-***/source |
通過安全隧道訪問對應設備，建立WebSocket的URL。 |
| TunnelId | String | d4098041-*** |
安全隧道ID。 |
| ErrorMessage | String | 系統異常 |
調用失敗時，返回的出錯信息。 |
| RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 |
阿里云為該請求生成的唯一標識符。 |
| Success | Boolean | true |
表示是否調用成功。
|
示例
請求示例
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=CreateDeviceTunnel
&ProductKey=a1rYuVF***
&DeviceName=light
&IotInstanceId=iot-***-v6***
&<公共請求參數>正常返回示例
XML格式
<CreateDeviceTunnelResponse>
<RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
<Data>
<SourceURI>wss://secure-tunnel-ws.iot.aliyun.test/tunnel/1834248a-37b7-4fd2-***/source</SourceURI>
<SourceAccessToken>521c43e4-a6da-***</SourceAccessToken>
<TunnelId>d4098041-***</TunnelId>
</Data>
<Success>true</Success>
</CreateDeviceTunnelResponse>JSON格式
{
"RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
"Data": {
"SourceURI": "wss://secure-tunnel-ws.iot.aliyun.test/tunnel/1834248a-37b7-4fd2-***/source",
"SourceAccessToken": "521c43e4-a6da-***",
"TunnelId": "d4098041-***"
},
"Success": true
}