OnsMessageTrace - - Centre de documentation Alibaba Cloud

Remarque

Utilisez cette opération pour vérifier si un message spécifique a été consommé. Si ce n'est pas le cas, diagnostiquez le problème à l'aide des informations renvoyées.
Cette opération récupère les informations en s'appuyant sur le mécanisme de décalage (offset) par défaut de Message Queue for Apache RocketMQ. Dans la plupart des cas, les résultats sont exacts. Toutefois, si vous avez réinitialisé le décalage du consommateur ou vidé les messages en file d'attente, les résultats peuvent être incorrects.

Limite de requêtes

Chaque compte Alibaba Cloud peut appeler cette opération jusqu'à 10 fois par seconde. Si le nombre de requêtes envoyées en une seconde atteint cette limite, les nouvelles requêtes échouent, ce qui peut interrompre votre activité. Pour plus d'informations sur les limites de requêtes de chaque opération, consultez la page Limites de requêtes API.

Autorisation

Par défaut, les comptes Alibaba Cloud peuvent appeler cette opération. Un utilisateur Resource Access Management (RAM) ne peut l'appeler qu'après avoir reçu les autorisations nécessaires. Le tableau suivant décrit les autorisations à accorder à un utilisateur RAM pour appeler cette opération. Pour savoir comment accorder des autorisations, consultez la page Politiques.

API

Action

Resource in an instance that uses a namespace

Resource in an instance that does not use a namespace

OnsMessageTrace

mq:QueryInstanceBaseInfo

mq:QueryMessageTrace

acs:mq:::{instanceId}%{topic}

acs:mq:::{topic}

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	OnsMessageTrace	Opération à effectuer. Définissez la valeur sur OnsMessageTrace.
Topic	String	Yes	test-mq_topic	Rubrique dans laquelle est stocké le message à interroger.
MsgId	String	Yes	1E05791C117818B4AAC23B1BB0CE****	ID du message à interroger.
InstanceId	String	Yes	MQ_INST_111111111111_DOxxxxxx	ID de l'instance Message Queue for Apache RocketMQ contenant le message à interroger.

Paramètres de réponse

Parameter	Type	Example	Description
RequestId	String	EAE5BE23-37A1-4354-94D6-E44AE17E****	ID de la requête. Le système génère un ID unique pour chaque requête. Utilisez cet ID pour le dépannage.
Data	Array of MessageTrack		Données renvoyées.
MessageTrack
TrackType	String	CONSUMED	État du message. Valeurs possibles : CONSUMED : Le message est consommé. CONSUMED_BUT_FILTERED: Aucun groupe de consommateurs n'est abonné au message. Le message est filtré et n'est pas consommé. NOT_CONSUME_YET : Le message n'est pas encore consommé. NOT_ONLINE : Le groupe de consommateurs est hors ligne. UNKNOWN : Le message n'est pas consommé pour des raisons inconnues.
ConsumerGroup	String	GID_test_group_id	ID du groupe de consommateurs abonné à la rubrique.
InstanceId	String	MQ_INST_111111111111_DOxxxxxx	ID de l'instance Message Queue for Apache RocketMQ contenant le message.

Exemples

Exemple de requête

http(s)://ons.cn-hangzhou.aliyuncs.com/?Action=OnsMessageTrace
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&MsgId=1E05791C117818B4AAC23B1BB0CE****
&Topic=test-mq_topic
&<Common request parameters>

Exemple de réponse réussie

Format XML

HTTP/1.1 200 OK
Content-Type:application/xml

<OnsMessageTraceResponse>
<Data>
    <MessageTrack>
        <InstanceId>MQ_INST_111111111111_DOxxxxxx</InstanceId>
        <ConsumerGroup>GID_test_group_id</ConsumerGroup>
        <TrackType>CONSUMED</TrackType>
    </MessageTrack>
</Data>
<RequestId>EAE5BE23-37A1-4354-94D6-E44AE17****</RequestId>
</OnsMessageTraceResponse>

Format JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Data" : {
    "MessageTrack" : [ {
      "InstanceId" : "MQ_INST_111111111111_DOxxxxxx",
      "ConsumerGroup" : "GID_test_group_id",
      "TrackType" : "CONSUMED"
    } ]
  },
  "RequestId" : "EAE5BE23-37A1-4354-94D6-E44AE17E****"
}

Codes d'erreur

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

Interroger l'état de consommation d'un message dans la console

Dans la console Message Queue for Apache RocketMQ, vous pouvez interroger l'état de consommation d'un message. Pour plus d'informations, consultez la page Interroger une trace de message.