InactivateCaCertificate - ApsaraMQ for MQTT - Alibaba Cloud Documentation Center

ApsaraMQ for MQTT supports X.509 certificate-based device verification. Clients use device certificates for connection authentication. A Certificate Authority (CA) certificate is used to issue device certificates to clients and to verify the validity of those certificates. If you do not need to use a CA certificate for a period of time, call this operation to unregister it. This changes the status of the CA certificate to inactive. When you need to use the CA certificate again, you can call the ActiveCaCertificate operation to reactivate it.

Operation description

Only Platinum Edition instances support the InactivateCaCertificate operation.
The request rate for a single user is limited to 500 per second. If you have special requirements, contact ApsaraMQ for MQTT technical support. The DingTalk group number is 35228338.
You can call this operation only for CA certificates that are registered with ApsaraMQ for MQTT. To query the registered CA certificates for an instance, call the ListCaCertificate operation.

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

none

*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 attached.	post-cn-7mz2d******
Sn	string	Yes	The serial number (SN) of the CA certificate that you want to unregister. The SN uniquely identifies a CA certificate. The value can be up to 128 bytes long.	007269004887******

Response elements

Parameter	Type	Description	Example
	object	The data returned.
RequestId	string	The ID of the request. This ID is unique for each request. You can use it to troubleshoot and locate issues.	020F6A43-19E6-4B6E-B846-44EB31DF****
Sn	string	The serial number (SN) of the unregistered CA certificate. The SN uniquely identifies a CA certificate.	007269004887******

Examples

Success response

JSON format

{
  "RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
  "Sn": "007269004887******"
}

Error codes

HTTP status code	Error code	Error message	Description
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.	ram permission check failed
403	MqttOwnerCheckError	Failed to validate the instance permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.