调用该接口查询单个安全隧道的详细信息，包括安全隧道的所属设备、创建时间、ID、连接状态等。

QPS限制

单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为5。

说明 RAM用户共享阿里云账号配额。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 QueryDeviceTunnel

系统规定参数。取值：QueryDeviceTunnel。
TunnelId String 是 d4098041-a560-***

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

实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。

注意
  • 若有ID值，必须传入该ID值，否则调用会失败。
  • 若无ID值，则无需传入。

实例的更多信息，请参见实例概述。

调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数文档。

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException

调用失败时，返回的错误码。更多信息，请参见错误码。

Data Struct

调用成功时，返回安全隧道的信息。
Description String 用于远程登录到摄像头。

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

设备端连接状态。

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

设备名称。
IotId String Q7uOhVRdZRRlDnTLv***00100

物联网平台为该设备颁发的ID，作为该设备的唯一标识符。
ProductKey String a1rYuVF***

设备所属产品的ProductKey。

ProductName String test

设备所属产品的名称。
SourceConnState String DISCONNECTED

访问端连接状态。

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

安全隧道的ID。
TunnelState String OPEN

安全隧道的状态。

  • OPEN：已打开，支持通过安全隧道访问对应设备。
  • CLOSED：已关闭，不支持通过安全隧道访问对应设备了。
Udi String reboot

推送给设备的自定义信息。
UtcClosed String 2021-09-22T12:44:12.000Z

安全隧道关闭的UTC时间。
UtcCreated String 2021-09-22T12:44:12.000Z

安全隧道创建的UTC时间。
ErrorMessage String 系统异常

调用失败时，返回的出错信息。
RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

阿里云为该请求生成的唯一标识符。
Success Boolean true

表示是否调用成功。

  • true：调用成功。
  • false：调用失败。

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceTunnel
&TunnelId=d4098041-a560-***
&IotInstanceId=iot-***-v6***
&<公共请求参数>

正常返回示例

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
}