ListMessages - - Centre de documentation Alibaba Cloud

Consulte la liste des messages.

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:ListMessages

list

*Topic.

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

Aucune

Syntaxe de la requête

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

Paramètres de chemin

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

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
messageId	string	Non	L'identifiant du message.	7F00000100207A4F0F294A938F7807AE
messageKey	string	Non	La clé du message.	XSCBillResult
startTime	string	Non	L'heure de début de la plage de temps de la requête. Format : YYYY-MM-DD HH:mm:ss.	2024-09-09 08:00:00
endTime	string	Non	L'heure de fin de la plage de temps de la requête. Format : YYYY-MM-DD HH:mm:ss.	2024-09-09 09:00:00
pageNumber	integer	Non	Le numéro de la page actuelle, à partir de 1.	1
pageSize	integer	Non	La taille de la page. Le nombre maximum de résultats à renvoyer par page.	10
scrollId	string	Non	L'identifiant de défilement pour la requête. Vous n'avez pas besoin de spécifier ce paramètre pour la requête de la première page. Pour les requêtes de pages suivantes, spécifiez ce paramètre en fonction de la valeur renvoyée par la première page.	B13D0B07-F24B-4790-88D8-D47A38063D00
liteTopicName	string	Non	Le nom du topic lite.	abc

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
requestId	string	L'identifiant de la requête.	A3531B6A-5A88-52BD-B3C4-A024C3D0AA2E
success	boolean	Indique si la requête a réussi.	true
data	object	Le résultat renvoyé.
pageNumber	integer	Le numéro de la page actuelle.	1
pageSize	integer	La taille de la page.	50
totalCount	integer	Le nombre total d'enregistrements.	0
list	array<object>	Les données paginées.
	array<object>	Les informations du message.
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
messageId	string	L'identifiant du message.	7F000001000114B4340C5ABF94500079
bornTime	string	L'heure à laquelle le message a été généré. Format : YYYY-MM-DD HH:mm:ss.	2023-03-22 12:17:08
storeTime	string	L'heure à laquelle le message a été stocké dans le broker de logs. Format : YYYY-MM-DD HH:mm:ss.	2023-03-22 12:17:08
body	string	Le corps du message.	{}
bodySize	integer	La taille du corps du message.	100
bornHost	string	Le client qui a produit le message.	xx.xx.xx.xx
storeHost	string	Le serveur broker de logs qui a stocké le message.	xx.xx.xx.xx
messageType	string	Le type de message.	NORMAL
messageTag	string	La balise du message.	xx
messageGroup	string	Le groupe de messages. Ce paramètre 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 utilisateur.
	string	La propriété utilisateur.	xx
liteTopicName	string	Le nom du topic lite.	abc
scrollId	string	L'identifiant de défilement pour la requête. Cette valeur est générée automatiquement par le système. Vous devez inclure cette valeur dans les requêtes de pages suivantes pour continuer la pagination.	B13D0B07-F24B-4790-88D8-D47A38063D00
code	string	Le code d'erreur.	MissingInstanceId
message	string	Le message d'erreur.	Le paramètre instanceId est obligatoire pour cette action
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": "A3531B6A-5A88-52BD-B3C4-A024C3D0AA2E",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 50,
    "totalCount": 0,
    "list": [
      {
        "regionId": "cn-hangzhou",
        "instanceId": "rmq-cn-7e22ody****",
        "topicName": "topic_test",
        "messageId": "7F000001000114B4340C5ABF94500079",
        "bornTime": "2023-03-22 12:17:08",
        "storeTime": "2023-03-22 12:17:08",
        "body": "{}",
        "bodySize": 100,
        "bornHost": "xx.xx.xx.xx",
        "storeHost": "xx.xx.xx.xx",
        "messageType": "NORMAL",
        "messageTag": "xx",
        "messageGroup": "xx",
        "messageKeys": [
          "xx"
        ],
        "userProperties": {
          "key": "xx"
        },
        "liteTopicName": "abc"
      }
    ],
    "scrollId": "B13D0B07-F24B-4790-88D8-D47A38063D00"
  },
  "code": "MissingInstanceId",
  "message": "Parameter instanceId is mandatory for this action",
  "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.