All Products
Search
Document Center

:List of operations by function

Last Updated:Oct 31, 2023

The following tables list cloud API operations available for use in ApsaraMQ for MQTT.

Note

Each successful call to a cloud API operation increases the number of messaging transactions per second (TPS) by one. Therefore, you are charged for the call. For information about the billing details, see Billing overview.

Token management

Token management operations are called by your application server.

API

Description

ApplyToken

Applies for a temporary access token.

QueryToken

Verifies the validity of a token.

RevokeToken

Revokes a token.

Group management

API

Description

CreateGroupId

Creates a group on a specific ApsaraMQ for MQTT instance.

DeleteGroupId

Deletes a group on a specific ApsaraMQ for MQTT instance.

ListGroupId

Queries all groups on a specific ApsaraMQ for MQTT instance.

Message sending

API

Description

SendMessage

Sends a message from an application on a cloud server to ApsaraMQ for MQTT.

Client status query

API

Description

QuerySessionByClientId

Queries the connection status of a specific device based on the client ID.

BatchQuerySessionByClientIds

Batch queries the connection status of multiple devices based on multiple client IDs.

Unique-certificate-per-device

API

Description

RegisterDeviceCredential

Applies for an access credential for a device.

GetDeviceCredential

Queries the access credential of a device.

UnRegisterDeviceCredential

Deletes the access credential of a device.

RefreshDeviceCredential

Updates the access credential of a device.

Trace query

API

Description

QueryMqttTraceDevice

Queries the traces of a device corresponding to an ApsaraMQ for MQTT client by page.

QueryMqttTraceMessageOfClient

Queries the messages of a specific device.

QueryMqttTraceMessagePublish

Queries the sending traces of a specific message.

QueryMqttTraceMessageSubscribe

Queries the delivery traces of a specific message.