GetCaCertificate API Reference for CA Certificate Details - ApsaraMQ for MQTT - Alibaba Cloud - ApsaraMQ for MQTT

Operation description

Only ApsaraMQ for MQTT Enterprise Platinum Edition instances support this operation.
Each Alibaba Cloud account can call this operation up to 500 times per second. To request a higher limit, join DingTalk group 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:GetCaCertificate

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 CA certificate is bound.	post-cn-7mz2d******
Sn	string	Yes	The serial number (SN) of the CA certificate. Each SN uniquely identifies a CA certificate.	007269004887******

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID. Each request has a unique ID for troubleshooting.	020F6A43-19E6-4B6E-B846-44EB31DF****
Data	object	The CA certificate details.
RegistrationCode	string	The registration code of the CA certificate.	13274673-8f90-4630-bea1-9cccb25756ad2089******
CaName	string	The name of the CA certificate.	mqtt_ca
Sn	string	The serial number (SN) of the CA certificate. Each SN uniquely identifies a CA certificate. Maximum length: 128 bytes.	00f26900ba87******
CaContent	string	The content of the CA certificate. Note `\n` represents a newline character.	-----BEGIN CERTIFICATE-----\nMIIDuzCCAqdGVzdC5jbi1xaW5n******\n-----END CERTIFICATE-----
VerificationContent	string	The content of the verification certificate. Note `\n` represents a newline character.	-----BEGIN CERTIFICATE-----\nMIID/DCCAu+Y5sRMpp9tnd+4s******\n-----END CERTIFICATE-----
ValidBegin	string	The time when the CA certificate takes effect, in milliseconds (Unix timestamp).	1654137303000
ValidEnd	string	The time when the CA certificate expires, in milliseconds (Unix timestamp).	1969497303000
Status	string	The status of the CA certificate. Valid values: 0: inactive. 1: active. Note A CA certificate is active by default after registration.	1

Examples

Success response

JSON format

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