調(diào)用該接口查詢單個安全隧道的詳細信息，包括安全隧道的所屬設(shè)備、創(chuàng)建時間、ID、連接狀態(tài)等。

QPS限制

單個阿里云賬號調(diào)用該接口的每秒請求數(shù)（QPS）最大限制為5。

說明 RAM用戶共享阿里云賬號配額。

調(diào)試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數(shù)

名稱 類型 是否必選 示例值 描述
Action String 是 QueryDeviceTunnel

系統(tǒng)規(guī)定參數(shù)。取值：QueryDeviceTunnel。
TunnelId String 是 d4098041-a560-***

要查詢安全隧道的ID。
IotInstanceId String 否 iot-***-v6***

實例ID。您可在物聯(lián)網(wǎng)平臺控制臺的實例概覽頁面，查看當(dāng)前實例的ID。

注意
  • 若有ID值，必須傳入該ID值，否則調(diào)用會失敗。
  • 若無ID值，則無需傳入。

實例的更多信息，請參見實例概述。

調(diào)用API時，除了本文介紹的該API的特有請求參數(shù)，還需傳入公共請求參數(shù)。公共請求參數(shù)說明，請參見公共參數(shù)文檔。

返回數(shù)據(jù)

名稱 類型 示例值 描述
Code String iot.system.SystemException

調(diào)用失敗時，返回的錯誤碼。更多信息，請參見錯誤碼。

Data Struct

調(diào)用成功時，返回安全隧道的信息。
Description String 用于遠程登錄到攝像頭。

安全隧道的描述信息。
DeviceConnState String CONNECTED

設(shè)備端連接狀態(tài)。

  • CONNECTED：已連接。
  • DISCONNECTED：未連接。
DeviceName String light

設(shè)備名稱。
IotId String Q7uOhVRdZRRlDnTLv***00100

物聯(lián)網(wǎng)平臺為該設(shè)備頒發(fā)的ID，作為該設(shè)備的唯一標(biāo)識符。
ProductKey String a1rYuVF***

設(shè)備所屬產(chǎn)品的ProductKey。

ProductName String test

設(shè)備所屬產(chǎn)品的名稱。
SourceConnState String DISCONNECTED

訪問端連接狀態(tài)。

  • CONNECTED：已連接。
  • DISCONNECTED：未連接。
TunnelId String d4098041-a560-***

安全隧道的ID。
TunnelState String OPEN

安全隧道的狀態(tài)。

  • OPEN：已打開，支持通過安全隧道訪問對應(yīng)設(shè)備。
  • CLOSED：已關(guān)閉，不支持通過安全隧道訪問對應(yīng)設(shè)備了。
Udi String reboot

推送給設(shè)備的自定義信息。
UtcClosed String 2021-09-22T12:44:12.000Z

安全隧道關(guān)閉的UTC時間。
UtcCreated String 2021-09-22T12:44:12.000Z

安全隧道創(chuàng)建的UTC時間。
ErrorMessage String 系統(tǒng)異常

調(diào)用失敗時，返回的出錯信息。
RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

阿里云為該請求生成的唯一標(biāo)識符。
Success Boolean true

表示是否調(diào)用成功。

  • true：調(diào)用成功。
  • false：調(diào)用失敗。

示例

請求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceTunnel
&TunnelId=d4098041-a560-***
&IotInstanceId=iot-***-v6***
&<公共請求參數(shù)>

正常返回示例

XML格式 

<QueryDeviceTunnelResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <IotId>Q7uOhVRdZRRlDnTLv***00100</IotId>
        <Description>用于遠程登錄到攝像頭。</Description>
        <UtcClosed>2021-09-22T12:44:12.000Z</UtcClosed>
        <UtcCreated>2021-09-22T12:44:12.000Z</UtcCreated>
        <DeviceConnState>CONNECTED</DeviceConnState>
        <TunnelState>OPEN</TunnelState>
        <SourceConnState>DISCONNECTED</SourceConnState>
        <Udi>reboot</Udi>
        <TunnelId>d4098041-a560-***</TunnelId>
        <ProductKey>a1rYuVF***</ProductKey>
        <ProductName>test</ProductName>
        <DeviceName>light</DeviceName>
  </Data>
  <Success>true</Success>
</QueryDeviceTunnelResponse>

JSON格式 

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "IotId": "Q7uOhVRdZRRlDnTLv***00100",
        "Description": "用于遠程登錄到攝像頭。",
        "UtcClosed": "2021-09-22T12:44:12.000Z",
        "UtcCreated": "2021-09-22T12:44:12.000Z",
        "DeviceConnState": "CONNECTED",
        "TunnelState": "OPEN",
        "SourceConnState": "DISCONNECTED",
        "Udi": "reboot",
        "TunnelId": "d4098041-a560-***",
        "ProductKey": "a1rYuVF***",
        "ProductName":"test",
        "DeviceName": "light"
    },
    "Success": true
}