The following tables list cloud API operations available for use in Message Queue 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 more information
about the billing details, see Billing.
Token management
Token management operations are called by your application server.
| API operation | Description |
|---|---|
| ApplyToken | Applies for a temporary access token. |
| QueryToken | Verifies the validity of a token. |
| RevokeToken | Revokes a token. |
Group management
| API operation | Description |
|---|---|
| CreateGroupId | Creates a group ID on a specified Message Queue for MQTT instance. |
| DeleteGroupId | Deletes a group ID from a specified Message Queue for MQTT instance. |
| ListGroupId | Queries all group IDs on a specified Message Queue for MQTT instance. |
Message sending
| API operation | Description |
|---|---|
| SendMessage | Sends a single message from an application on a cloud server to Message Queue for MQTT. |
Device status query
| API operation | Description |
|---|---|
| QuerySessionByClientId | Queries the connection status of a device based on a specified client ID. |
| BatchQuerySessionByClientIds | Batch queries the connection status of multiple devices based on multiple client IDs. |
Unique-certificate-per-device
| API operation | Description |
|---|---|
| RegisterDeviceCredential | Creates 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 operation | Description |
|---|---|
| QueryMqttTraceDevice | Queries the traces of a device corresponding to a Message Queue for MQTT client by page. |
| QueryMqttTraceMessageOfClient | Queries the messages of a specified device. |
| QueryMqttTraceMessagePublish | Queries the sending traces of a specified message. |
| QueryMqttTraceMessageSubscribe | Queries the delivery traces of a specified message. |