Deregisters a device certificate. Device certificates are digital certificates issued to clients by certificate authority (CA) root certificates. When you connect an ApsaraMQ for MQTT client to an ApsaraMQ for MQTT broker, the broker uses the device certificate to authenticate the client. If the client passes the authentication, the client and the broker can communicate with each other based on the encrypted private key in the device certificate. If the client fails the authentication, access requests from the client are denied by the client.
Operation description
- Only ApsaraMQ for MQTT Enterprise Platinum Edition instances support this operation.
- You can call this operation up to 500 times per second per Alibaba Cloud account. If you want to increase the limit, join the DingTalk group (ID: 35228338) to contact ApsaraMQ for MQTT technical support.
Debugging
Authorization information
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| MqttInstanceId | string | Yes | The ID of the ApsaraMQ for MQTT instance to which the device certificate that you want to deregister is bound. | post-cn-7mz2d****** |
| DeviceSn | string | Yes | The serial number of the device certificate that you want to deregister. The serial number is the unique identifier of a device. | 356217374433****** |
| CaSn | string | Yes | The serial number of the CA certificate to which the device certificate that you want to deregister belongs. The serial number is the unique identifier of a CA certificate. The serial number of a CA certificate cannot exceed 128 bytes in size. | 007269004887****** |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
"DeviceSn": "356217374433******"
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | ParameterFieldCheckFailed | Failed to validate the parameters. The parameters may be missing or invalid. |
| 500 | FindDeviceBySnError | Failed to find the device certificate by the SN. Please check sn is valid |
| 500 | MqttInstanceNotFound | Specified instance is not found |
| 500 | MqttOwnerCheckError | Failed to validate the instance permission |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2022-08-24 | Add Operation | View Change Details |