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}
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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
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
Status code: 204
no content
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot