更新时间:2024-10-23 GMT+08:00

删除设备隧道

功能介绍

用户可通过该接口删除某个设备隧道。删除后该通道不存在,无法再次连接。

  • 该API接口在基础版不支持。

  • 具体应用可见“设备远程登录”功能,请参见设备远程登录

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

DELETE /v5/iot/{project_id}/tunnels/{tunnel_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数说明:项目ID。获取方法请参见 获取项目ID

tunnel_id

String

隧道ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证

Instance-Id

String

参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考 查看实例详情

响应参数

请求示例

删除设备隧道。

DELELE https://{endpoint}/v5/iot/{project_id}/tunnels/{tunnel_id}

响应示例

状态码

状态码

描述

204

no content

400

输入参数不正确

401

Unauthorized

403

鉴权认证失败

404

隧道不存在

500

Internal Server Error

错误码

请参见错误码