Queries all certificate authority (CA) certificates that are registered with an ApsaraMQ for MQTT instance. 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
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:ListCaCertificate | list | *Instance acs:mq:{#regionId}:{#accountId}:{#InstanceId} |
|
|
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| MqttInstanceId | string | Yes | The instance ID of the Cloud Message Queue MQTT version, indicating which instance's CA certificates need to be viewed. | post-cn-7mz2d****** |
| PageNo | string | Yes | Indicates the page number of the returned results. The starting page is counted from 1. | 2 |
| PageSize | string | Yes | The maximum number of query records to display per page. Value range: 1 to 100. | 10 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
"Data": {
"Total": 1,
"PageNo": 2,
"PageSize": 10,
"CaCertificateVOS": [
{
"RegistrationCode": "13274673-8f90-4630-bea1-9cccb25756ad2089******",
"CaName": "mqtt_ca",
"Sn": "007269004887******",
"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 |
|---|---|---|
| 500 | ParameterFieldCheckFailed | Failed to validate the parameters. The parameters may be missing or invalid. |
| 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 |