RegisterCaCertificate
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:RegisterCa | create | *Instance acs:mq:{#regionId}:{#accountId}:{#InstanceId} |
|
|
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| MqttInstanceId | string | Yes | The ID of the ApsaraMQ for MQTT instance to which you want to bind the CA certificate. | post-cn-7mz2d****** |
| CaName | string | Yes | The name of the CA certificate that you want to register with an ApsaraMQ for MQTT broker. | mqtt_ca |
| CaContent | string | Yes | The content of the CA certificate that you want to register with an ApsaraMQ for MQTT broker. Note
In the example, \n indicates a line feed.
| -----BEGIN CERTIFICATE-----\nMIIDuzCCAqdGVzdC5jbi1xaW5n******\n-----END CERTIFICATE----- |
| VerificationContent | string | Yes | The content of the validation certificate issued by the CA certificate that you want to register with an ApsaraMQ for MQTT broker. The validation certificate must be used together with the registration code of the CA certificate to verify the private key of the CA certificate. Note
In the example, \n indicates a line feed.
| -----BEGIN CERTIFICATE-----\nMIID/DCCAu+Y5sRMpp9tnd+4s******\n-----END CERTIFICATE----- |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
"Sn": "007269004887******"
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | ParameterFieldCheckFailed | Failed to validate the parameters. The parameters may be missing or invalid. |
| 400 | InstancePermissionCheckFailed | An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings. |
| 500 | RegisterCodeError | Register code error in verification certificate. |
| 500 | RegisterCodeUsed | Register code has been used. |
| 500 | GetCaNumError | Failed to get ca num. Try again later. |
| 500 | CaNumExceed | CA certificate num exceed |
| 500 | CertificateContentError | Certificate content error, please check ca/verification certificate content. BasicConstraints extension should be set to true in CA certificate |
| 500 | SnNotUnique | Sn is not unique in gloabal |
| 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 |
| 2024-03-20 | The Error code has changed | View Change Details |
| 2022-08-24 | The Error code has changed | View Change Details |
- Only Platinum and Professional instances support using the RegisterCaCertificate interface. - The request frequency limit per user is 500 times/second. For special requirements, please contact Cloud Message Queue MQTT version technical support, DingTalk group number: 35228338.