Deregisters the access credential of a device. After the access credential of a device is deregistered, you can no longer use the access credential to authenticate the device on the ApsaraMQ for MQTT broker.
Operation description
- You can call this operation up to 500 times per second per account. If the limit is exceeded, throttling is triggered. This may affect your business. We recommend that you take note of this limit when you call this operation. For more information, see Limits on QPS.
- Each successful call to the UnRegisterDeviceCredential operation increases the number of transactions per second (TPS) by one. This affects the billing of your instance. For more information, see Billing rules.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ClientId | string | Yes | The client ID of the device whose access credential you want to deregister. | GID_test@@@test |
| InstanceId | string | Yes | The ID of the ApsaraMQ for MQTT instance. The ID must be consistent with the ID of the instance that the ApsaraMQ for MQTT client uses. You can obtain the instance ID on the Instance Details page that corresponds to the instance in the ApsaraMQ for MQTT console. | post-cn-0pp12gl**** |
Note
For information about other parameters, see Common parameters and Endpoints .
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "E4581CCD-62AF-44D9-B5B4-D1DBDC0E****"
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | ApplyTokenOverFlow | You have applied for tokens too many times. Please try again later. |
| 400 | CheckAccountInfoFailed | An error occurred while checking the account information by the STS token. |
| 400 | InstancePermissionCheckFailed | An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings. |
| 400 | ParameterCheckFailed | An error occurred while validating the parameters. The parameters may be missing or invalid. |
| 400 | PermissionCheckFailed | An error occurred while validating the resource permissions. Please check the account that created the instance, topic, and GroupId, and check their permission settings. |
| 400 | InvalidParameter.%s | An error occurred while validating the parameter. The parameter may be missing or invalid. |
| 404 | ApiNotSupport | The specified API is not supported. |
| 500 | InternalError | An error occurred while processing your request. Try again later. |
| 500 | SystemOverFlow | An error occurred while processing your request. Please try again. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2023-12-28 | The Error code has changed | see changesets | ||||||||
|