Updated on 2024-12-02 GMT+08:00

Disable a Device Tunnel

Function

This API is used by an application to disable a device tunnel. After the disabling, the tunnel can be connected again.

  • This API is not supported by Basic editions.

  • For details, see [Remote Login] (https://support.huaweicloud.com/intl/en-us/usermanual-iothub/iot_01_00301.html).

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Parameter description: project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

tunnel_id

Yes

String

Tunnel ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

Parameter description: user token. You can obtain the token by calling the IAM API Obtaining a User Token Through Password Authentication. In the returned response header, X-Subject-Token is the desired user token. For details about how to obtain the token, see Token Authentication.

Instance-Id

No

String

Parameter description: instance ID. Unique identifier of each instance in the physical multi-tenant scenario. Mandatory for professional editions and recommended in other cases. Log in to the IoTDA console and choose Overview in the navigation pane to view the instance ID. For details, see Viewing Instance Details.

Response Parameters

None

Example Requests

Disables a device tunnel.

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

Example Responses

None

Status Codes

Status Code

Description

204

no content

400

Invalid value.

401

Unauthorized

403

Authentication failed.

404

The tunnel does not exist.

500

Internal Server Error

Error Codes

See Error Codes.