Deletes all ClientIDs of a device if the number of ClientIDs exceeds the limit 5. This API operation applies to preregistration-free unique-certificate-per-product authentication.

Usage notes

  • You can call the QueryClientIds operation to view the ClientIDs of a device and obtain the number of ClientIDs.
  • After you call the DeleteClientIds operation, all ClientIDs of the device are deleted and cannot be resumed. To obtain a new ClientID, you can register the device again.

Limits

Each Alibaba Cloud account can run a maximum of 10 queries per second (QPS).

Note 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 DeleteClientIds

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

IotId String Yes BXPV9Ks3bxwM9fD****0000101

The ID of the device.

IotInstanceId String No iot-12****78

The ID of the instance. You can view the instance ID on the Overview page in the IoT Platform console.

Notice
  • If your instance has an ID, you must configure this parameter. If you do not set this parameter, the call fails.
  • If your instance has no Overview page or ID, you do not need to set this parameter.

For more information, see Overview.

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

Response parameters

Parameter Type Example Description
Code String Success

The response code. The value Success indicates that the call was successful. Other values indicate that errors occurred. For more information about error codes, see Error codes.

ErrorMessage String request parameter error

The error message returned if the call fails.

RequestId String 89F22330-BAEE-****-****-41BA46D6E267

The ID of the request.

Success Boolean true

Indicates whether the call was successful.

  • true: The call was successful.
  • false: The call failed.

Examples

Sample requests

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=DeleteClientIds
&IotId=BXPV9Ks3bxwM9fD****0000101
&<Common request parameters>

Sample success responses

XML format 

<DeleteClientIdsResponse>
  <RequestId>89F22330-BAEE-****-****-41BA46D6E267</RequestId>
  <Code>Success</Code>
  <Success>true</Success>
</DeleteClientIdsResponse>

JSON format 

{
    "RequestId": "89F22330-BAEE-****-****-41BA46D6E267",
    "Code": "Success",
    "Success": true
}

Error codes

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