查询设备所有隧道
功能介绍
用户可通过该接口查询某项目下的所有设备隧道，以实现对设备管理。应用服务器可通过此接口向平台查询设备隧道建立的情况。
该API接口在基础版不支持。
具体应用可见“设备远程登录”功能，请参见设备远程登录。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v5/iot/{project_id}/tunnels
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
参数说明：项目ID。获取方法请参见 获取项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
device_id |
否 |
String |
参数说明：设备ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
否 |
String |
参数说明：用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 |
Instance-Id |
否 |
String |
参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考 查看实例详情。 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
tunnels |
Array of TunnelInfo objects |
隧道信息列表。 数组长度：0 - 100 |
参数 |
参数类型 |
描述 |
|---|---|---|
tunnel_id |
String |
隧道ID |
device_id |
String |
设备ID |
create_time |
String |
隧道创建时间。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。 |
closed_time |
String |
隧道更新时间。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。 |
status |
String |
隧道状态 CLOSED | OPEN |
source_connect_state |
ConnectState object |
访问端（console）状态 |
device_connect_state |
ConnectState object |
设备端状态 |
请求示例
列表查询设备隧道。
GET https://{endpoint}/v5/iot/{project_id}/tunnels
响应示例
状态码： 200
查询设备所有隧道信息成功
{
"tunnels" : [ {
"tunnel_id" : "d144a524-1997-4b99-94bf-f27128da8a34",
"device_id" : "1a7ffc5c-d89c-44dd-8265-b1653d951ce0",
"create_time" : "20190303T081011Z",
"closed_time" : "20190303T081011Z",
"status" : "CLOSED",
"source_connect_state" : {
"last_update_time" : "20190303T081011Z",
"status" : "CONNECTED"
},
"device_connect_state" : {
"last_update_time" : "20190303T081011Z",
"status" : "CONNECTED"
}
} ]
}
状态码
状态码 |
描述 |
|---|---|
200 |
查询设备所有隧道信息成功 |
400 |
输入参数不正确 |
401 |
Unauthorized |
403 |
鉴权认证失败 |
500 |
Internal Server Error |
错误码
请参见错误码。
