tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DeleteDevice

Last updated: 2022-09-28 10:37:23

1. API Description

Domain name for API request: iotcloud.tencentcloudapi.com.

This API is used to delete an IoT Hub device.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DeleteDevice.
Version Yes String Common Params. The value used for this API: 2021-04-08.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ProductId Yes String ID of the product to which the device belongs
DeviceName Yes String Name of the device to delete
Skey No String Skey, which is required to delete a LoRa device or LoRa gateway device

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Deleting a device

Input Example

https://iotcloud.tencentcloudapi.com/?Action=DeleteDevice
&ProductId=ABCDE12345
&DeviceName=abc
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "xxxxxxxxxxxxxxxxxxxxxxx"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
InternalError.DBOperationError An internal database error occurred.
InvalidParameterValue Invalid parameter value.
ResourceNotFound.DeviceNotExist The device does not exist.
ResourceNotFound.ProductNotExist The product does not exist.
UnauthorizedOperation.DeviceHasAlreadyBindGateway Unable to delete this device as gateway devices have been bound to it.
UnauthorizedOperation.GatewayHasBindedDevices There are still devices bound to this device.
UnsupportedOperation.DeviceOtaTaskInProgress Device OTA update is in progress.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy