GetCaCertificate - ApsaraMQ for MQTT - Alibaba Cloud Documentation Center

Queries the details of a certificate authority (CA) certificate, such as the content and status of the certificate. ApsaraMQ for MQTT allows you to use X.509 certificates for authentication. When you connect an ApsaraMQ for MQTT client to an ApsaraMQ for MQTT broker, you can use the device certificate to implement authentication. CA certificates are used to issue device certificates to clients and validate the device certificates.

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
MqttInstanceId	string	Yes	The instance ID bound to the CA certificate, which is the instance ID of the MQTT version of the cloud message queue.	post-cn-7mz2d******
Sn	string	Yes	The SN serial number of the CA certificate to be queried, used to uniquely identify a CA certificate.	007269004887******

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	Public parameters, each request ID is unique and can be used for troubleshooting and problem localization.	020F6A43-19E6-4B6E-B846-44EB31DF****
Data	object	Certificate details.
RegistrationCode	string	Registration code of the CA certificate	13274673-8f90-4630-bea1-9cccb25756ad2089******
CaName	string	Name of the CA certificate	mqtt_ca
Sn	string	The SN serial number of the CA certificate, used to uniquely identify a CA certificate. Value range: no more than 128 bytes.	00f26900ba87******
CaContent	string	Content of the CA certificate. Note \n represents a new line.	-----BEGIN CERTIFICATE-----\nMIIDuzCCAqdGVzdC5jbi1xaW5n******\n-----END CERTIFICATE-----
VerificationContent	string	Content of the Verification certificate. Note \n represents a new line.	-----BEGIN CERTIFICATE-----\nMIID/DCCAu+Y5sRMpp9tnd+4s******\n-----END CERTIFICATE-----
ValidBegin	string	The start time when the CA certificate becomes effective. The format is a Unix timestamp in milliseconds.	1654137303000
ValidEnd	string	The end time when the CA certificate becomes effective. The format is a Unix timestamp in milliseconds.	1969497303000
Status	string	The status of the CA certificate. The values are as follows: 0: Indicates that the certificate is in an inactive state. - 1: Indicates that the certificate is in an active state. Note After the CA certificate is registered, it is in an active state by default.	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
  "Data": {
    "RegistrationCode": "13274673-8f90-4630-bea1-9cccb25756ad2089******",
    "CaName": "mqtt_ca",
    "Sn": "00f26900ba87******",
    "CaContent": "-----BEGIN CERTIFICATE-----\\nMIIDuzCCAqdGVzdC5jbi1xaW5n******\\n-----END CERTIFICATE-----",
    "VerificationContent": "-----BEGIN CERTIFICATE-----\\nMIID/DCCAu+Y5sRMpp9tnd+4s******\\n-----END CERTIFICATE-----",
    "ValidBegin": "1654137303000",
    "ValidEnd": "1969497303000",
    "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	FindCaBySnError	Failed to find the CA by the SN. Please check sn is valid.
500	MqttOwnerCheckError	Failed to validate the instance permission
500	MqttInstanceNotFound	Specified instance is not found

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
2022-08-24	The Error code has changed	View Change Details