GetMessageDetail - - Centre de documentation Alibaba Cloud

Obtient les détails d'un message 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:GetMessageDetail

get

*Topic.

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

Aucune

Syntaxe de la requête

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

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
instanceId	string	Oui	L'identifiant de l'instance.	rmq-cn-lbj31fs790d
topicName	string	Oui	Le nom du sujet.	flink_test
messageId	string	Oui	L'identifiant du message.	0A792FDB001F7591083D30ADB1DA11D5

Paramètres de requête

Paramètre

Type

Requis

Description

Exemple

Éléments de réponse

Élément	Type	Description	Exemple
	object	Result
requestId	string	L'identifiant de la requête.	FAEBD71F-E839-52F9-BD7B-8F1290525841
success	boolean	Indique si la requête a réussi.	true
data	object	Les données de réponse.
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 sujet.	topic_test
messageId	string	L'identifiant du message.	01BE87E485F0C7808C04543CAF00000001
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 courtier de journaux, au format AAAA-MM-JJ HH:mm:ss.	2023-03-22 12:17:08
body	string	Le corps du message.	{}
bodySize	integer	La taille du corps du message.	123
bornHost	string	L'hôte depuis lequel le message a été émis.	xxx.xx.xxx.xx
storeHost	string	L'hôte du courtier de journaux où le message est stocké.	xxx.xx.xxx.xx
messageType	string	Le type de message.	NORMAL
messageTag	string	La liste des balises.	xx
messageGroup	string	L'ancienne clé de partitionnement. Ce champ s'applique uniquement aux messages ordonnés.	xx
messageKeys	array	Les clés du message.
	string	L'identifiant.	xx
userProperties	object	Les propriétés utilisateur.
	string	Les propriétés utilisateur.	xxx
systemProperties	object	Les propriétés système par défaut.
	string	Les propriétés système par défaut.	xx
liteTopicName	string	Le nom du sujet Lite.	abc
priority	integer	La priorité.	7
code	string	Le code d'erreur.	Topic.NotFound
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": "FAEBD71F-E839-52F9-BD7B-8F1290525841",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "topicName": "topic_test",
    "messageId": "01BE87E485F0C7808C04543CAF00000001",
    "bornTime": "2023-03-22 12:17:08",
    "storeTime": "2023-03-22 12:17:08",
    "body": "{}",
    "bodySize": 123,
    "bornHost": "xxx.xx.xxx.xx",
    "storeHost": "xxx.xx.xxx.xx",
    "messageType": "NORMAL",
    "messageTag": "xx",
    "messageGroup": "xx",
    "messageKeys": [
      "xx"
    ],
    "userProperties": {
      "key": "xxx"
    },
    "systemProperties": {
      "key": "xx"
    },
    "liteTopicName": "abc",
    "priority": 7
  },
  "code": "Topic.NotFound",
  "message": "Le paramètre instanceId est obligatoire pour cette 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.