云端API概览

微消息队列MQTT版提供以下云端API接口。

Token应用服务器接口

此类接口由您的应用服务器调用。

API	描述
ApplyToken	调用ApplyToken申请临时访问的Token。
QueryToken	调用QueryToken校验Token的有效性。
RevokeToken	调用RevokeToken吊销Token。

Group管理接口

API	描述
CreateGroupId	调用CreateGroupId创建某微消息队列MQTT版实例下的Group ID。
DeleteGroupId	调用DeleteGroupId删除某微消息队列MQTT版实例下的Group ID。
ListGroupId	调用ListGroupId查询某微消息队列MQTT版实例下的Group ID。

消息发送接口

API	描述
SendMessage	调用SendMessage从服务端应用发送消息至微消息队列MQTT版。

设备状态查询接口

API	描述
QuerySessionByClientId	调用QuerySessionByClientId根据Client ID查询设备连接状态。
BatchQuerySessionByClientIds	调用BatchQuerySessionByClientIds根据多个Client ID批量查询设备连接状态。

一机一密接口

API	描述
RegisterDeviceCredential	调用RegisterDeviceCredential为设备申请访问凭证。
GetDeviceCredential	调用GetDeviceCredential查询设备的访问凭证。
UnRegisterDeviceCredential	调用UnRegisterDeviceCredential注销设备的访问凭证。
RefreshDeviceCredential	调用RefreshDeviceCredential更新设备的访问凭证。

轨迹查询接口

API	描述
QueryMqttTraceDevice	调用QueryMqttTraceDevice分页查询微消息队列MQTT版客户端的设备轨迹。
QueryMqttTraceMessageOfClient	调用QueryMqttTraceMessageOfClient查询指定设备的消息收发列表。
QueryMqttTraceMessagePublish	调用QueryMqttTraceMessagePublish查询指定消息的发送轨迹。
QueryMqttTraceMessageSubscribe	调用QueryMqttTraceMessageSubscribe查询指定消息的投递轨迹。

CA证书管理接口

API	描述
RegisterCaCertificate	调用RegisterCaCertificate将CA证书注册到微消息队列MQTT版服务端中。
ActiveCaCertificate	调用ActiveCaCertificate激活CA证书。
InactivateCaCertificate	调用InactivateCaCertificate注销CA证书。
ListCaCertificate	调用ListCaCertificate查询指定实例下所有注册的CA证书。
GetCaCertificate	调用GetCaCertificate查询某一个指定的CA证书。
GetRegisterCode	调用GetRegisterCode获取CA证书的注册码。
DeleteCaCertificate	调用DeleteCaCertificate将CA证书信息从微消息队列MQTT版服务端中删除。

设备证书管理接口

API	描述
ActiveDeviceCertificate	调用ActiveDeviceCertificate激活设备证书。
InactivateDeviceCertificate	调用InactivateDeviceCertificate注销设备证书。
ListDeviceCertificate	调用ListDeviceCertificate查询指定实例下所有已注册的设备证书。
ListDeviceCertificateByCaSn	调用GetDeviceCertificateByCaSn查询指定CA证书下所有已注册的设备证书。
GetDeviceCertificate	调用GetDeviceCertificate获取指定设备证书的详细信息。
DeleteDeviceCertificate	调用DeleteDeviceCertificate将设备证书信息从微消息队列MQTT版服务端中删除。