GetTrace - - Centre de documentation Alibaba Cloud

Obtient la trace d'un message spécifié dans un sujet spécifié.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

rocketmq:GetTrace

get

*Topic.

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}

Aucune

Syntaxe de la requête

GET /instances/{instanceId}/topics/{topicName}/traces/{messageId} HTTP/1.1

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
instanceId	string	Oui	L'identifiant de l'instance à interroger.	rmq-cn-zvp2vtypu05
topicName	string	Oui	Le nom du sujet à interroger.	linkedcare-image
messageId	string	Oui	L'identifiant du message.	012A5AB0BBEC8A000104C6342B00001ECF

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
startTime	string	Non	L'heure de début, au format AAAA-MM-JJ HH:mm:ss.	2023-05-10 10:42:11
endTime	string	Non	L'heure de fin, au format AAAA-MM-JJ HH:mm:ss.	2024-09-09 09:00:00

Éléments de réponse

Élément	Type	Description	Exemple
	object	Résultat.
requestId	string	L'identifiant de la requête. Chaque requête possède un identifiant unique que vous pouvez utiliser pour résoudre les problèmes.	7779A8FC-1BCD-5A1D-A603-C4A9BD8ADC49
success	boolean	Indique si la requête a réussi.	true
data	object	Le résultat renvoyé.
regionId	string	L'identifiant de la région.	cn-hangzhou
instanceId	string	L'identifiant de l'instance.	rmq-cn-7e22ody****
topicName	string	Le nom du topic.	topic_test
messageInfo	object	Les informations du message.
regionId	string	L'identifiant de la région.	cn-beijing
instanceId	string	L'identifiant de l'instance.	rmq-cn-u0t2ygjq505
topicName	string	Le nom du topic.	Topic_normal_inspector
messageId	string	L'identifiant du message.	0A79275A00207A4F0F2916C92F9A0B94
bornTime	string	L'heure à laquelle le message a été généré, au format AAAA-MM-JJ HH:mm:ss.	2023-03-22 12:17:08
storeTime	string	L'heure à laquelle le message a été stocké dans le broker, au format AAAA-MM-JJ HH:mm:ss.	2023-03-22 12:17:08
body	string	Le corps du message.	{}
bornHost	string	L'origine du message.	x.x.x.x
storeHost	string	L'adresse du broker où le message est stocké.	x.x.x.x
messageType	string	Le type de message.	NORMAL
messageTag	string	La liste des balises.	xx
messageGroup	string	La clé de partitionnement. Ce champ est exclusif aux messages ordonnés.	xx
messageKeys	array	La clé du message.
	string	La clé du message.	xx
userProperties	object	Les propriétés de l'utilisateur.
	string	Les propriétés de l'utilisateur.	xx
transactionId	string	L'identifiant de la transaction.	xx
liteTopicName	string	Le nom du topic Lite.	abc
producerInfo	object	Les informations de traçabilité des messages du producteur.
records	array<object>	La liste des enregistrements du producteur.
	object	La liste des enregistrements du producteur.
userName	string	Le nom du producteur.	xxx
clientHost	string	Le nom d'hôte.	xx.xx.xx.xx
produceTime	string	L'heure à laquelle le message a été envoyé, au format AAAA-MM-JJ HH:mm:ss.	2023-03-22 12:17:08
produceDuration	integer	Le temps nécessaire pour envoyer le message.	100
produceStatus	string	L'état de l'envoi.	SUCCESS
arriveTime	string	L'heure à laquelle le message est arrivé, au format AAAA-MM-JJ HH:mm:ss.	2023-03-22 12:17:08
messageSource	string	La source du message.	CONSOLE
dlqOriginTopic	string	Le topic de la file d'attente de lettres mortes.	test_topic
dlqOriginMessageId	string	L'identifiant du message de la file d'attente de lettres mortes.	0A79275A00207A4F0F2916C92F9A0B94
recallTime	string	L'heure à laquelle la demande de rappel a été initiée. Ce champ n'est pas vide lorsque messageSource est « recall ».	2023-03-22 12:17:08
brokerInfo	object	Les informations de traçabilité des messages du broker.
presetDelayTime	string	L'heure de livraison prédéfinie, au format AAAA-MM-JJ HH:mm:ss.	2023-03-22 12:17:08
delayStatus	string	L'état du message planifié.	SUCCESS
operations	array<object>	La liste des opérations.
	object	La liste des opérations.
operateType	string	Le type d'opération.	ADD
operateTime	string	L'heure de l'opération, au format AAAA-MM-JJ HH:mm:ss.	2023-03-22 12:17:08
recallResult	string	Le résultat du rappel. Ce champ n'est pas vide lorsqu'un enregistrement de rappel existe.	RECALL_OK \| RECALL_FAIL
consumerInfos	array<object>	Les informations de traçabilité des messages du consommateur.
	array<object>	Les informations de traçabilité des messages du consommateur.
consumerGroupId	string	L'identifiant du groupe de consommateurs.	GID_inspector_group
records	array<object>	La liste des enregistrements de consommation.
	array<object>	La liste des enregistrements de consommation.
userName	string	Le nom du consommateur.	test
clientHost	string	Le nom d'hôte.	xx.xx.xx.xx
fifoEnable	boolean	Indique si la consommation ordonnée est activée.	true
consumeStatus	string	L'état de la consommation.	SUCCESS
operations	array<object>	La liste des opérations.
	object	La liste des opérations.
operateType	string	Le type d'opération.	ADD
operateTime	string	L'heure de l'opération, au format AAAA-MM-JJ HH:mm:ss.	2023-03-22 12:17:08
invisibleTime	integer	Le temps d'invisibilité, en millisecondes.	100
deadMessage	boolean	Indique si le message est une lettre morte.	true
popCk	string	POP_CK.	123
consumeStatus	string	L'état de la consommation.	SUCCESS
deadMessage	boolean	Indique si le message est une lettre morte.	true
deadLetterInfo	object	Les informations sur la lettre morte.
topicName	string	Le nom du topic.	Register_Sync
messageId	string	L'identifiant du message.	7F000001001F7A4F0F29463F0376047D
toDlqTime	string	L'heure à laquelle le message est arrivé dans la file d'attente des lettres mortes, au format AAAA-MM-JJ HH:mm:ss.	2023-03-22 12:17:08
code	string	Le code d'erreur.	InvalidConsumerGroupId
message	string	Le message d'erreur.	L'instance est introuvable
httpStatusCode	integer	Le code d'état HTTP.	200
dynamicCode	string	Le code d'erreur dynamique.	InstanceId
dynamicMessage	string	Le message d'erreur dynamique.	instanceId

Exemples

JSON format

{
  "requestId": "7779A8FC-1BCD-5A1D-A603-C4A9BD8ADC49",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "topicName": "topic_test",
    "messageInfo": {
      "regionId": "cn-beijing",
      "instanceId": "rmq-cn-u0t2ygjq505",
      "topicName": "Topic_normal_inspector",
      "messageId": "0A79275A00207A4F0F2916C92F9A0B94",
      "bornTime": "2023-03-22 12:17:08",
      "storeTime": "2023-03-22 12:17:08",
      "body": "{}",
      "bornHost": "x.x.x.x",
      "storeHost": "x.x.x.x",
      "messageType": "NORMAL",
      "messageTag": "xx",
      "messageGroup": "xx",
      "messageKeys": [
        "xx"
      ],
      "userProperties": {
        "key": "xx"
      },
      "transactionId": "xx",
      "liteTopicName": "abc"
    },
    "producerInfo": {
      "records": [
        {
          "userName": "xxx",
          "clientHost": "xx.xx.xx.xx",
          "produceTime": "2023-03-22 12:17:08",
          "produceDuration": 100,
          "produceStatus": "SUCCESS",
          "arriveTime": "2023-03-22 12:17:08",
          "messageSource": "CONSOLE",
          "dlqOriginTopic": "test_topic",
          "dlqOriginMessageId": "0A79275A00207A4F0F2916C92F9A0B94",
          "recallTime": "2023-03-22 12:17:08"
        }
      ]
    },
    "brokerInfo": {
      "presetDelayTime": "2023-03-22 12:17:08",
      "delayStatus": "SUCCESS",
      "operations": [
        {
          "operateType": "ADD",
          "operateTime": "2023-03-22 12:17:08"
        }
      ],
      "recallResult": "RECALL_OK | RECALL_FAIL"
    },
    "consumerInfos": [
      {
        "consumerGroupId": "GID_inspector_group",
        "records": [
          {
            "userName": "test",
            "clientHost": "xx.xx.xx.xx",
            "fifoEnable": true,
            "consumeStatus": "SUCCESS",
            "operations": [
              {
                "operateType": "ADD",
                "operateTime": "2023-03-22 12:17:08",
                "invisibleTime": 100,
                "deadMessage": true
              }
            ],
            "popCk": "123"
          }
        ],
        "consumeStatus": "SUCCESS",
        "deadMessage": true,
        "deadLetterInfo": {
          "topicName": "Register_Sync",
          "messageId": "7F000001001F7A4F0F29463F0376047D",
          "toDlqTime": "2023-03-22 12:17:08"
        }
      }
    ]
  },
  "code": "InvalidConsumerGroupId",
  "message": "L'instance est introuvable",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.