ListTraces - - Centre de documentation Alibaba Cloud

Consulte les traces de messages pour un topic 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:ListTraces

get

*Topic

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

Aucune

Syntaxe de la requête

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

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
instanceId	string	Oui	L'identifiant de l'instance.	rmq-cn-tl32upjeb08
topicName	string	Oui	Le nom du topic.	topic_hpms_product_price_change

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
startTime	string	Oui	L'heure de début.	2023-05-10 10:42:11
endTime	string	Oui	L'heure de fin.	2023-05-19 10:10:09
pageNumber	integer	Oui	Le numéro de page des résultats à renvoyer.	1
pageSize	integer	Oui	Le nombre d'entrées à renvoyer sur chaque page.	10
queryType	string	Oui	Le type de requête. Valeurs valides : MESSAGE_ID : MESSAGE_ID. MESSAGE_KEY : MESSAGE_KEY. TOPIC : TOPIC.	MESSAGE_ID
messageId	string	Non	L'identifiant du message. Ce paramètre est requis si queryType est défini sur MESSAGE_ID.	0100163E0EC1F1965C04C7906700000000
messageKey	string	Non	La clé du message. Ce paramètre est requis si queryType est défini sur MESSAGE_KEY.	order_ceating
liteTopicName	string	Non	Le nom du topic allégé.	abc

Éléments de réponse

Élément	Type	Description	Exemple
	object	Schéma de la réponse.
requestId	string	Identifiant de la requête.	EDFF77E1-1ED1-5389-B6A8-651D9433BBE5
success	boolean	Indique si la requête a réussi.	true
code	string	Le code d'erreur.	Topic.NotFound
message	string	Le message d'erreur.	Le paramètre instanceId est obligatoire pour cette action
data	object	Les données renvoyées.
pageNumber	integer	Le numéro de la page renvoyée.	1
pageSize	integer	Le nombre d'entrées renvoyées par page.	10
totalCount	integer	Le nombre total d'entrées renvoyées.	1
list	array<object>	Les données paginées.
	object	Les données paginées.
regionId	string	The region ID.	cn-hangzhou
instanceId	string	The instance ID.	rmq-cn-7e22ody****
topicName	string	The topic name.	topic_test
messageId	string	The message ID.	7F00000100207A4F0F294A938F7807AE
bornTime	string	The time when the message was created.	2023-03-22 12:17:08
messageTag	string	The message tag.	xx
messageKeys	array	The business keys.
	string	A business key.	xx
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": "EDFF77E1-1ED1-5389-B6A8-651D9433BBE5",
  "success": true,
  "code": "Topic.NotFound",
  "message": "Parameter instanceId is mandatory for this action .",
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 1,
    "list": [
      {
        "regionId": "cn-hangzhou",
        "instanceId": "rmq-cn-7e22ody****",
        "topicName": "topic_test",
        "messageId": "7F00000100207A4F0F294A938F7807AE",
        "bornTime": "2023-03-22 12:17:08",
        "messageTag": "xx",
        "messageKeys": [
          "xx"
        ]
      }
    ]
  },
  "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.