QueryMqttTraceMessageOfClient - - Centre de documentation Alibaba Cloud

Interroge les messages d'un appareil spécifique.

Facturation

Chaque appel réussi à l'opération QueryMqttTraceMessageOfClient augmente le nombre de transactions de messagerie par seconde (TPS) d'une unité. Cet appel est donc facturé. Pour plus de détails sur la facturation, consultez la rubrique Facturation.

Limite QPS

La limite de requêtes par seconde (QPS) pour cette opération est de 500 par utilisateur. Un dépassement de ce seuil déclenche une limitation du débit (throttling), susceptible d'affecter votre activité. Adaptez vos appels à cette opération en fonction de vos besoins. Pour plus d'informations, consultez la rubrique Limites QPS.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	QueryMqttTraceMessageOfClient	Opération à effectuer. Définissez la valeur sur QueryMqttTraceMessageOfClient.
MqttRegionId	String	Oui	cn-hangzhou	ID de région de l'instance ApsaraMQ forMQTT. Pour plus d'informations, consultez Endpoints.
InstanceId	String	Oui	mqtt-cn-i7m26mf****	ID de l'instance ApsaraMQ forMQTT. La valeur doit correspondre à l'ID d'instance utilisé sur le client ApsaraMQ forMQTT. Vous pouvez consulter l'ID d'instance dans la section Basic Information de la page Instance Details de l'instance dans la console ApsaraMQ forMQTT.
ClientId	String	Oui	GID_test@@@producer	ID client de l'appareil dont vous souhaitez interroger les messages.
BeginTime	Long	Oui	1618646400000	Début de la plage temporelle à interroger. Cette valeur est un horodatage UNIX représentant le nombre de millisecondes écoulées depuis le 1er janvier 1970, 00:00:00 UTC. Unité : millisecondes.
EndTime	Long	Oui	1621591200000	Fin de la plage temporelle à interroger. Cette valeur est un horodatage UNIX représentant le nombre de millisecondes écoulées depuis le 1er janvier 1970, 00:00:00 UTC. Unité : millisecondes.
CurrentPage	Integer	Oui	1	Numéro de la page à renvoyer. La numérotation des pages commence à 1. Si la valeur du paramètre d'entrée est supérieure au nombre total de pages, le résultat renvoyé est vide.
PageSize	Integer	Oui	5	Nombre d'entrées à renvoyer par page. Valeurs valides : de 1 à 100.
Reverse	Boolean	Non	false	Indique si les résultats renvoyés sont affichés dans l'ordre chronologique inverse. Valeurs valides : true : Les résultats sont affichés dans l'ordre inverse de l'envoi ou de la consommation du message. Le dernier message envoyé ou consommé apparaît en premier et le plus ancien en dernier. false : Les résultats sont affichés dans l'ordre chronologique de l'envoi ou de la consommation du message. Le message le plus ancien envoyé ou consommé apparaît en premier et le plus récent en dernier. Si ce paramètre n'est pas spécifié, les résultats sont affichés dans l'ordre chronologique de l'envoi ou de la consommation du message.

Paramètres de réponse

Paramètre	Type	Exemple	Description
RequestId	String	B096B9D6-62F3-4567-BB59-58D1362E****	ID de la requête. Il s'agit d'un paramètre commun. Chaque requête possède un ID unique, facilitant le dépannage et l'identification des problèmes.
Total	Long	5	Nombre total de messages renvoyés.
CurrentPage	Integer	1	Numéro de la page renvoyée.
PageSize	Integer	10	Nombre d'entrées renvoyées par page.
MessageOfClientList	Array of MessageOfClientList		Messages renvoyés.
Action	String	pub_mqtt	Action effectuée sur le message. Valeurs valides : pub_mqtt : Le client ApsaraMQ forMQTT envoie le message. sub : Le client ApsaraMQ forMQTT s'abonne au message. push_offline : Le broker ApsaraMQ forMQTT pousse le message hors ligne vers le client ApsaraMQ forMQTT.
ActionCode	String	mqtt.trace.action.msg.pub.mqtt	Code renvoyé pour l'action sur le message. Valeurs valides : mqtt.trace.action.msg.pub.mqtt : Cette valeur est renvoyée si la valeur du paramètre Action est pub_mqtt. mqtt.trace.action.msg.sub : Cette valeur est renvoyée si la valeur du paramètre Action est sub. mqtt.trace.action.msg.push.offline : Cette valeur est renvoyée si la valeur du paramètre Action est push_offline.
ActionInfo	String	Pub From Mqtt Client	Informations renvoyées pour l'action sur le message. Valeurs valides : Pub From Mqtt Client : Cette valeur est renvoyée si la valeur du paramètre Action est pub_mqtt. Push To Mqtt Client : Cette valeur est renvoyée si la valeur du paramètre Action est sub. Push Offline Msg To Mqtt Client : Cette valeur est renvoyée si la valeur du paramètre Action est push_offline.
ClientId	String	GID_test@@@producer	ID client de l'appareil.
MsgId	String	AC1EC0030EAB78308DB16A3EC773****	ID du message.
Time	String	2021-05-21 15:08:19.234	Heure d'envoi ou de consommation du message.

Exemples

Exemples de requêtes

http(s)://onsmqtt.cn-hangzhou.aliyuncs.com/?Action=QueryMqttTraceMessageOfClient
&MqttRegionId=cn-hangzhou
&InstanceId=mqtt-cn-i7m26mf****
&ClientId=GID_test@@@producer
&BeginTime=1618646400000
&EndTime=1621591200000
&CurrentPage=1
&PageSize=5
&<Common request parameters>

Exemples de réponses réussies

Format XML

<QueryMqttTraceMessageOfClientResponse>
   <RequestId>B096B9D6-62F3-4567-BB59-58D1362E****</RequestId>
   <PageSize>10</PageSize>
   <CurrentPage>1</CurrentPage>
   <Total>5</Total>
   <MessageOfClientList>
        <Action>pub_mqtt</Action>
        <ActionCode>mqtt.trace.action.msg.pub.mqtt</ActionCode>
        <ClientId>GID_test@@@producer</ClientId>
        <ActionInfo>Pub From Mqtt Client</ActionInfo>
        <Time>2021-05-21 15:08:19.210 </Time>
        <MsgId>AC1EC0030EAB78308DB16A3EC773****</MsgId>
   </MessageOfClientList>
   <MessageOfClientList>
        <Action>pub_mqtt</Action>
        <ActionCode>mqtt.trace.action.msg.pub.mqtt</ActionCode>
        <ClientId>GID_test@@@producer</ClientId>
        <ActionInfo>Pub From Mqtt Client</ActionInfo>
        <Time>2021-05-21 15:08:19.234 </Time>
        <MsgId>AC1EC0030EAB78308DB16A3EC78F****</MsgId>
   </MessageOfClientList>
   <MessageOfClientList>
        <Action>pub_mqtt</Action>
        <ActionCode>mqtt.trace.action.msg.pub.mqtt</ActionCode>
        <ClientId>GID_test@@@producer</ClientId>
        <ActionInfo>Pub From Mqtt Client</ActionInfo>
        <Time>2021-05-21 15:08:19.234 </Time>
        <MsgId>AC1EC0030EAB78308DB16A3EC78F****</MsgId>
   </MessageOfClientList>
   <MessageOfClientList>
        <Action>pub_mqtt</Action>
        <ActionCode>mqtt.trace.action.msg.pub.mqtt</ActionCode>
        <ClientId>GID_test@@@producer</ClientId>
        <ActionInfo>Pub From Mqtt Client</ActionInfo>
        <Time>2021-05-21 15:08:19.234 </Time>
        <MsgId>AC1EC0030EAB78308DB16A3EC78F****</MsgId>
   </MessageOfClientList>
   <MessageOfClientList>
        <Action>pub_mqtt</Action>
        <ActionCode>mqtt.trace.action.msg.pub.mqtt</ActionCode>
        <ClientId>GID_test@@@producer</ClientId>
        <ActionInfo>Pub From Mqtt Client</ActionInfo>
        <Time>2021-05-21 15:08:19.234 </Time>
        <MsgId>AC1EC0030EAB78308DB16A3EC78F****</MsgId>
   </MessageOfClientList>
</QueryMqttTraceMessageOfClientResponse>

Format JSON

{
  "RequestId": "B096B9D6-62F3-4567-BB59-58D1362E****",
  "PageSize": 10,
  "CurrentPage": 1,
  "Total": 5,
  "MessageOfClientList": [
    {
      "Action": "pub_mqtt",
      "ActionCode": "mqtt.trace.action.msg.pub.mqtt",
      "ClientId": "GID_test@@@producer",
      "ActionInfo": "Pub From Mqtt Client",
      "Time": "2021-05-21 15:08:19.210 ",
      "MsgId": "AC1EC0030EAB78308DB16A3EC77****"
    },
    {
      "Action": "pub_mqtt",
      "ActionCode": "mqtt.trace.action.msg.pub.mqtt",
      "ClientId": "GID_test@@@producer",
      "ActionInfo": "Pub From Mqtt Client",
      "Time": "2021-05-21 15:08:19.234 ",
      "MsgId": "AC1EC0030EAB78308DB16A3EC78F****"
    },
    {
      "Action": "pub_mqtt",
      "ActionCode": "mqtt.trace.action.msg.pub.mqtt",
      "ClientId": "GID_test@@@producer",
      "ActionInfo": "Pub From Mqtt Client",
      "Time": "2021-05-21 15:08:19.234 ",
      "MsgId": "AC1EC0030EAB78308DB16A3EC78F****"
    },
    {
      "Action": "pub_mqtt",
      "ActionCode": "mqtt.trace.action.msg.pub.mqtt",
      "ClientId": "GID_test@@@producer",
      "ActionInfo": "Pub From Mqtt Client",
      "Time": "2021-05-21 15:08:19.234 ",
      "MsgId": "AC1EC0030EAB78308DB16A3EC78F****"
    },
    {
      "Action": "pub_mqtt",
      "ActionCode": "mqtt.trace.action.msg.pub.mqtt",
      "ClientId": "GID_test@@@producer",
      "ActionInfo": "Pub From Mqtt Client",
      "Time": "2021-05-21 15:08:19.234 ",
      "MsgId": "AC1EC0030EAB78308DB16A3EC78F****"
    }
  ]
}

Codes d'erreur

HttpCode	Code d'erreur	Message d'erreur	Description
500	SystemOverFlow	An error occurred while processing your request. Please try again.	Le message d'erreur indique que la limitation du débit a été déclenchée par le système. Réessayez ultérieurement.
404	ApiNotSupport	The specified API operation is not supported.	Le message d'erreur indique que l'opération API n'est pas prise en charge.

Pour obtenir la liste des codes d'erreur, visitez le Centre d'erreurs API.

Opérations dans la console ApsaraMQ forMQTT

Outre l'appel à l'opération QueryMqttTraceMessageOfClient, vous pouvez également consulter les messages d'un appareil directement dans la console ApsaraMQ forMQTT. Pour plus d'informations, consultez la rubrique Interroger les traces de messages.