InactivateDeviceCertificate - ApsaraMQ for MQTT - Alibaba Cloud Documentation Center

A device certificate is a digital certificate that a root Certificate Authority (CA) issues to a client device. The service uses this certificate to authenticate the client during connection. If authentication is successful, the service and the client can communicate securely using the encryption key in the certificate. If authentication fails, the service denies the client's connection. If you temporarily do not need to use a device certificate, you can call this operation to inactivate the device certificate, which changes its status to inactive.

Operation description

Only Platinum Edition instances support the InactivateDeviceCertificate operation.
The request frequency for a single user is limited to 500 calls per second. For special requirements, contact ApsaraMQ for MQTT technical support. The DingTalk group number is 35228338.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mq:UnregisterDeviceCertificate

none

*Instance

acs:mq:{#regionId}:{#accountId}:{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
MqttInstanceId	string	Yes	The ID of the ApsaraMQ for MQTT instance to which the device certificate is attached.	post-cn-7mz2d******
DeviceSn	string	Yes	The serial number (SN) of the device certificate that you want to inactivate. The SN uniquely identifies a device certificate.	356217374433******
CaSn	string	Yes	The SN of the CA certificate to which the device certificate belongs. The SN uniquely identifies a CA certificate. The value can be up to 128 bytes in length.	007269004887******

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request. This common parameter is unique to each request. Use this ID to troubleshoot issues.	020F6A43-19E6-4B6E-B846-44EB31DF****
DeviceSn	string	The SN of the inactivated device certificate. The SN uniquely identifies a device certificate.	356217374433******

Examples

Success response

JSON format

{
  "RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
  "DeviceSn": "356217374433******"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ParameterFieldCheckFailed	Failed to validate the parameters. The parameters may be missing or invalid.
500	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
403	PermissionCheckFailed	Failed to verify API permissions.	ram permission check failed
403	MqttOwnerCheckError	Failed to validate the instance permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.