GetDeviceCertificate API Overview - ApsaraMQ for MQTT - Alibaba Cloud - ApsaraMQ for MQTT

Queries the details of a device certificate. Device certificates are digital certificates issued to clients by certificate authority (CA) root certificates. When a client connects to an ApsaraMQ for MQTT broker, the broker authenticates the client by using the device certificate. If the authentication succeeds, the client and the broker communicate securely based on the encrypted private key in the certificate. If the authentication fails, the broker denies the connection request.

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.

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:GetDeviceCertificate

get

*Instance

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

None

mq:MqttInstanceAccess

Request parameters

Parameter	Type	Required	Description	Example
MqttInstanceId	string	Yes	The ID of the ApsaraMQ for MQTT instance to which the device certificate is bound.	post-cn-7mz2d******
DeviceSn	string	Yes	The serial number (SN) of the device certificate. The SN uniquely identifies a device certificate. Maximum length: 128 bytes.	356217374433******
CaSn	string	Yes	The serial number (SN) of the CA certificate that issued the device certificate. The SN uniquely identifies a CA certificate. Maximum length: 128 bytes.	007269004887******

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID. Each request has a unique ID, which you can use for troubleshooting.	020F6A43-19E6-4B6E-B846-44EB31DF****
Data	object	Certificate details.
ValidBegin	string	The time when the device certificate takes effect, in milliseconds (Unix timestamp).	1654137303000
ValidEnd	string	The time when the device certificate expires, in milliseconds (Unix timestamp).	1969497303000
DeviceSn	string	The serial number (SN) of the device certificate. The SN uniquely identifies a device certificate.	356217374433******
DeviceName	string	The name of the device certificate.	mqtt_device
DeviceContent	string	The content of the device certificate. \n represents a new line.	-----BEGIN DEVICECERTIFICATE-----\nMIIDuzCCAqdGVzdC5jbi1xaW5n******\n-----END DEVICECERTIFICATE-----
CaSn	string	The serial number (SN) of the CA certificate that issued the device certificate. The SN uniquely identifies a CA certificate.	00f26900ba87******
Status	string	The status of the device certificate. Valid values: 0: inactive. 1: active. Note After the device certificate is registered, it is active by default.	1

Examples

Success response

JSON format

{
  "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.
400	MqttOwnerCheckError	Failed to validate the instance permission
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.