ActiveDeviceCertificate - ApsaraMQ for MQTT - Alibaba Cloud Documentation Center

Device certificates, issued by certificate authority (CA) certificates, are used by the ApsaraMQ for MQTT broker to authenticate clients. The broker validates a device certificate against the registered CA certificate; upon successful authentication, the certificate is automatically registered with the broker and activated. Should a device certificate become inactive, you can call this operation to reactivate it.

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.

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

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 device certificate is bound.	post-cn-7mz2d******
DeviceSn	string	Yes	The serial number of the device certificate that you want to reactivate. The serial number is the unique identifier of a device certificate.	356217374433******
CaSn	string	Yes	The serial number of the CA certificate that issued the device certificate. The serial number is the unique identifier of a CA certificate. The serial number of a CA certificate cannot exceed 128 bytes in size.	007269004887******

Response elements

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request. This is a common parameter. Each request has a unique ID that you can use to troubleshoot issues.	020F6A43-19E6-4B6E-B846-44EB31DF****
DeviceSn	string	The serial number of the activated device certificate. The SN is the unique identifier of a device certificate.	356217374433******

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	ParameterFieldCheckFailed	Failed to validate the parameters. The parameters may be missing or invalid.
500	ParameterFieldCheckFailed	Failed to validate the parameters. The parameters may be missing or invalid.
500	FindDeviceBySnError	Failed to find the device certificate 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.