QueryMqttTraceDevice - - Centre de documentation Alibaba Cloud

Interroge les traces d'un appareil associé à un client ApsaraMQ for MQTT, page par page. En cas d'anomalie sur un appareil, appelez cette opération pour consulter l'historique des connexions afin de diagnostiquer et identifier la cause du problème.

Facturation

Chaque appel réussi à l'opération QueryMqttTraceDevice 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. Le dépassement de ce seuil déclenche une limitation du débit (throttling), susceptible d'affecter vos activités. Appelez cette opération selon vos besoins réels. Pour en savoir plus, consultez la rubrique Limites QPS.

Débogage

OpenAPI Explorer calcule automatiquement la signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. Il 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	QueryMqttTraceDevice	Nom de l'opération à effectuer. Définissez la valeur sur QueryMqttTraceDevice.
MqttRegionId	String	Oui	cn-hangzhou	ID de région de l'instance ApsaraMQ for MQTT. Pour plus d'informations, consultez la rubrique Points de terminaison.
InstanceId	String	Oui	mqtt-cn-i7m26mf****	ID de l'instance ApsaraMQ for MQTT. La valeur doit correspondre à l'ID utilisé par le client ApsaraMQ for MQTT. Vous pouvez consulter cet ID dans la section Basic Information de la page Instance Details de l'instance, dans la console ApsaraMQ for MQTT.
ClientId	String	Oui	GID_test@@@producer	ID client de l'appareil dont vous souhaitez consulter les traces.
BeginTime	Long	Oui	1621580400000	Début de la plage de temps à interroger. Cette valeur correspond à un horodatage UNIX (nombre de millisecondes écoulées depuis le 1er janvier 1970, 00:00:00 UTC). Unité : millisecondes.
EndTime	Long	Oui	1621584000000	Fin de la plage de temps à interroger. Cette valeur correspond à un horodatage UNIX (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 commence à 1. Si la valeur spécifiée dépasse le nombre total de pages, le résultat renvoyé est vide.
PageSize	Integer	Oui	5	Nombre d'entrées à renvoyer par page. Valeurs possibles : 1 à 100.
Reverse	Boolean	Oui	false	Indique si les résultats sont affichés par ordre chronologique inverse. Valeurs possibles : true : Affichage dans l'ordre inverse des actions. Les informations relatives à la dernière action apparaissent en premier, et celles relatives à la première action en dernier. false : Affichage dans l'ordre chronologique des actions. Les informations relatives à la première action apparaissent en premier, et celles relatives à la dernière action en dernier. Valeur par défaut : false.

Paramètres de réponse

Paramètre	Type	Exemple	Description
RequestId	String	317076B7-F946-46BC-A98F-4CF9777C****	ID de la requête. Ce paramètre commun identifie chaque requête de manière unique, ce qui facilite le dépannage.
Total	Long	3	Nombre total d'entrées renvoyées.
CurrentPage	Integer	1	Numéro de la page renvoyée.
PageSize	Integer	2	Nombre d'entrées renvoyées par page.
DeviceInfoList	Array of DeviceInfoList		Détails d'une entrée.
Action	String	connect	Action effectuée sur l'appareil. Valeurs possibles : connect : Le client ApsaraMQ for MQTT demande une connexion au broker ApsaraMQ for MQTT. close : La connexion TCP est fermée. disconnect : Le client ApsaraMQ for MQTT envoie une demande de déconnexion du broker ApsaraMQ for MQTT.
ActionCode	String	mqtt.trace.action.connect	Code associé à l'action sur l'appareil. Valeurs possibles : mqtt.trace.action.connect : Renvoyé si le paramètre Action vaut connect . mqtt.trace.action.close : Renvoyé si le paramètre Action vaut close. mqtt.trace.action.disconnect : Renvoyé si le paramètre Action vaut disconnect.
ActionInfo	String	accept	Informations renvoyées concernant l'action sur l'appareil. Valeurs possibles : accepted : Le broker ApsaraMQ for MQTT a reçu la demande de connexion du client. not authorized : La connexion TCP est fermée car la vérification des autorisations d'accès du client à l'instance a échoué. clientId conflict : La connexion TCP est fermée en raison d'un conflit d'ID client. resource auth failed : La connexion TCP est fermée car la vérification des autorisations d'accès du client au topic ou à l'ID de groupe a échoué. no heart : La connexion TCP est fermée en raison de l'absence de signal heartbeat. closed by client : La connexion TCP est fermée en raison d'une exception sur le client. disconnected by client : Le client a demandé la déconnexion. invalid param : La connexion TCP est fermée en raison de paramètres de requête non valides. Socket IOException : La connexion TCP est fermée en raison d'instabilités réseau ou de pertes de paquets.
ChannelId	String	c69fe839209547fa9d073781b9cd****	ID de la connexion.
Time	String	2021-05-21 15:51:54.867	Heure à laquelle l'action s'est produite sur l'appareil.

Exemples

Exemple de requête

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

Exemple de réponse réussie

Format XML

<QueryMqttTraceDeviceResponse>
  <DeviceInfoList>
        <Action>connect</Action>
        <ActionCode>mqtt.trace.action.connect</ActionCode>
        <ActionInfo>accepted</ActionInfo>
        <Time>2021-05-21 15:10:21.844</Time>
        <ChannelId>27e1c09a1d7d4944901500db7186****</ChannelId>
   </DeviceInfoList>
   <DeviceInfoList>
        <Action>close</Action>
        <ActionCode>mqtt.trace.action.close</ActionCode>
        <ActionInfo>no heart</ActionInfo>
        <Time>2021-05-21 15:51:37.980</Time>
        <ChannelId>27e1c09a1d7d4944901500db7186****</ChannelId>
   </DeviceInfoList>
   <DeviceInfoList>
        <Action>connect</Action>
        <ActionCode>mqtt.trace.action.connect</ActionCode>
        <ActionInfo>accepted</ActionInfo>
        <Time>2021-05-21 15:52:48.669</Time>
        <ChannelId>34022074d3c1403faba6e0334121****</ChannelId>
   </DeviceInfoList>
   <PageSize>5</PageSize>
   <CurrentPage>1</CurrentPage>
   <Total>3</Total>
   <RequestId>317076B7-F946-46BC-A98F-4CF9777C****</RequestId>
</QueryMqttTraceDeviceResponse>

Format JSON

{
    "DeviceInfoList": [
    {
      "Action": "connect",
      "ActionCode": "mqtt.trace.action.connect",
      "ActionInfo": "accepted",
      "Time": "2021-05-21 15:10:21.844",
      "ChannelId": "27e1c09a1d7d4944901500db7186****"
    },
    {
      "Action": "close",
      "ActionCode": "mqtt.trace.action.close",
      "ActionInfo": "no heart",
      "Time": "2021-05-21 15:51:37.980",
      "ChannelId": "27e1c09a1d7d4944901500db7186****"
    },
    {
      "Action": "connect",
      "ActionCode": "mqtt.trace.action.connect",
      "ActionInfo": "accepted",
      "Time": "2021-05-21 15:52:48.669",
      "ChannelId": "34022074d3c1403faba6e0334121****"
    }
  ],
    "PageSize": 5,
    "CurrentPage": 1,
    "Total": 3,
    "RequestId": "317076B7-F946-46BC-A98F-4CF9777C****"
}

Codes d'erreur

HttpCode	Code d'erreur	Message d'erreur	Description
500	SystemOverFlow	An error occurred while processing your request. Please try again.	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.	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 for MQTT

Outre l'appel à l'opération QueryMqttTraceDevice, vous pouvez également consulter les traces des appareils dans la console ApsaraMQ for MQTT. Pour plus d'informations, consultez la rubrique Interroger les traces des appareils.