Queries the details of 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
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| mq:GetDeviceCertificate | get | *Instance acs:mq:{#regionId}:{#accountId}:{#InstanceId} |
|
|
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| MqttInstanceId | string | Yes | The instance ID to which the device certificate is bound, i.e., the instance ID of the Cloud Message Queue MQTT version. | post-cn-7mz2d****** |
| DeviceSn | string | Yes | The SN serial number of the device certificate to be queried, used to uniquely identify a device certificate. Value range: no more than 128 bytes. | 356217374433****** |
| CaSn | string | Yes | The SN serial number of the CA certificate to which the device certificate to be queried belongs, used to uniquely identify a CA certificate. Value range: no more than 128 bytes. | 007269004887****** |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
"Data": {
"ValidBegin": 1654137303000,
"ValidEnd": 1969497303000,
"DeviceSn": "356217374433******",
"DeviceName": "mqtt_device",
"DeviceContent": "-----BEGIN DEVICECERTIFICATE-----\\nMIIDuzCCAqdGVzdC5jbi1xaW5n******\\n-----END DEVICECERTIFICATE-----",
"CaSn": "00f26900ba87******",
"Status": 1
}
}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 |
|---|---|---|
| 2025-02-18 | The Error code has changed | View Change Details |