Deletes a device.

Limits

  • After you delete a device, the ID of the device is invalid. The information that is related to the device is deleted. You cannot perform an operation on the device.
  • You must specify the IotId parameter or a combination of the ProductKey and DeviceName parameters to identify a device.
  • Each Alibaba Cloud account can run a maximum of 500 queries per second (QPS).
    Note Resource Access Management (RAM) users of an Alibaba Cloud account share the quota of the account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DeleteDevice

The operation that you want to perform. Set the value to DeleteDevice.

IotInstanceId String No iot-cn-0pp1n8t****

The instance ID. This parameter is not required for public instances. However, the parameter is required for the instances that you have purchased.

IotId String No MpEKNuEUJzIORNANAWJX0010929900*****

The ID of the device.

Note If you specify this parameter, you do not need to specify the ProductKey or DeviceName parameter. The IotId parameter specifies a unique identifier for the device, and corresponds to a combination of the ProductKey and DeviceName parameters. If you specify the IotId parameter and a combination of the ProductKey and DeviceName parameters at the same time, the IotId parameter takes precedence.
ProductKey String No a1FlqIQ****

The key of the product to which the device belongs.

Note If you specify this parameter, you must also specify the DeviceName parameter.
DeviceName String No light

The name of the device.

Note If you specify this parameter, you must also specify the ProductKey parameter.

In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this API operation. For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
Code String iot.prod.NullProductKey

The error code returned if the call fails. For more information, see Error codes.

ErrorMessage String The product ID is invalid.

The error message returned if the call fails.

RequestId String 57b144cf-09fc-4916-a272-a62902d5b207

The ID of the request.

Success Boolean false

Indicates whether the call succeeds.

  • true: The call succeeded.
  • false: The call failed.

Examples

Sample requests

https://iot.cn-shanghai.aliyuncs.com/?Action=DeleteDevice
&ProductKey=a1rYuVF****
&DeviceName=device1
&<Common request parameters>

Sample success responses

XML format

<DeleteDeviceResponse>
  <RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
  <Success>true</Success>
</DeleteDeviceResponse>

JSON format

{
  "RequestId":"57b144cf-09fc-4916-a272-a62902d5b207",
  "Success": true
}

Error codes

For a list of error codes, visit the API Error Center.