Obtient la trace d'un message spécifié dans 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
|
rocketmq:GetTrace |
get |
*Topic
|
Aucune | Aucune |
Syntaxe de la requête
GET /instances/{instanceId}/topics/{topicName}/traces/{messageId} HTTP/1.1Paramè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 topic à 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. |
2023-05-10 10:42:11 |
| endTime |
string |
Non |
L'heure de fin. |
2024-09-09 09:00:00 |
Éléments de réponse
|
Élément |
Type |
Description |
Exemple |
|
object |
La réponse. |
||
| requestId |
string |
L'identifiant de la requête. Chaque requête possède un identifiant unique. Vous pouvez utiliser cet identifiant pour résoudre les problèmes. |
7779A8FC-1BCD-5A1D-A603-C4A9BD8ADC49 |
| success |
boolean |
Indique si la requête a réussi. |
true |
| data |
object |
Les données renvoyées. |
|
| 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 |
The region ID. |
cn-beijing |
| instanceId |
string |
The instance ID. |
rmq-cn-u0t2ygjq505 |
| topicName |
string |
The topic name. |
Topic_normal_inspector |
| messageId |
string |
The message ID. |
0A79275A00207A4F0F2916C92F9A0B94 |
| bornTime |
string |
The time when the message was generated. |
2023-03-22 12:17:08 |
| storeTime |
string |
The time when the message was stored. |
2023-03-22 12:17:08 |
| body |
string |
The message body. |
{} |
| bornHost |
string |
The source of the message. |
x.x.x.x |
| storeHost |
string |
The location where the message is stored. |
x.x.x.x |
| messageType |
string |
The message type. |
NORMAL |
| messageTag |
string |
The list of tags. |
xx |
| messageGroup |
string |
The former sharding key. This parameter is specific to ordered messages. |
xx |
| messageKeys |
array |
The business ID. |
|
|
string |
The business ID. |
xx |
|
| userProperties |
object |
The user-defined properties. |
|
|
string |
The user-defined properties. |
xx |
|
| transactionId |
string |
The transaction ID. |
xx |
| liteTopicName |
string |
The name of the lightweight topic. |
abc |
| producerInfo |
object |
Les informations de trace du producteur. |
|
| records |
array<object> |
The list of production records. |
|
|
object |
The list of production records. |
||
| userName |
string |
The producer name. |
xxx |
| clientHost |
string |
The hostname. |
xx.xx.xx.xx |
| produceTime |
string |
The time when the message was sent. |
2023-03-22 12:17:08 |
| produceDuration |
integer |
The time taken to send the message. |
100 |
| produceStatus |
string |
The sending status. |
SUCCESS |
| arriveTime |
string |
The arrival time. |
2023-03-22 12:17:08 |
| messageSource |
string |
The message source. |
CONSOLE |
| dlqOriginTopic |
string |
The dead-letter queue topic. |
test_topic |
| dlqOriginMessageId |
string |
The ID of the message in the dead-letter queue. |
0A79275A00207A4F0F2916C92F9A0B94 |
| recallTime |
string |
The time when the revoke request was initiated. This field is not empty when `messageSource` is `recall`. |
Empty | 2023-03-22 12:17:08 |
| brokerInfo |
object |
Les informations de trace du broker. |
|
| presetDelayTime |
string |
The preset delivery time. |
2023-03-22 12:17:08 |
| delayStatus |
string |
The status of the scheduled message. |
SUCCESS |
| operations |
array<object> |
The list of operations. |
|
|
object |
The list of operations. |
||
| operateType |
string |
The operation type. |
ADD |
| operateTime |
string |
The operation time. |
2023-03-22 12:17:08 |
| recallResult |
string |
The result of the revoke operation. This field is not empty when a revoke record exists. |
Empty | RECALL_OK | RECALL_FAIL |
| consumerInfos |
array<object> |
Les informations de trace du consommateur. |
|
|
array<object> |
Les informations de trace du consommateur. |
||
| consumerGroupId |
string |
The consumer group ID. |
GID_inspector_group |
| records |
array<object> |
The list of consumption records. |
|
|
array<object> |
The list of consumption records. |
||
| userName |
string |
The consumer name. |
test |
| clientHost |
string |
The hostname. |
xx.xx.xx.xx |
| fifoEnable |
boolean |
Indicates whether messages are consumed in order. |
true |
| consumeStatus |
string |
The consumption status. |
SUCCESS |
| operations |
array<object> |
The list of operations. |
|
|
object |
The list of operations. |
||
| operateType |
string |
The operation type. |
ADD |
| operateTime |
string |
The operation time. |
2023-03-22 12:17:08 |
| invisibleTime |
integer |
The invisibility duration, in milliseconds. |
100 |
| deadMessage |
boolean |
Indicates whether the message is a dead-letter message. |
true |
| popCk |
string |
The POP checkpoint. |
123 |
| consumeStatus |
string |
The consumption status. |
SUCCESS |
| deadMessage |
boolean |
Indicates whether the message is a dead-letter message. |
true |
| deadLetterInfo |
object |
The information about the dead-letter message. |
|
| topicName |
string |
The topic name. |
Register_Sync |
| messageId |
string |
The message ID. |
7F000001001F7A4F0F29463F0376047D |
| toDlqTime |
string |
The time when the message arrived at the dead-letter queue. |
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": "Empty | 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": "Empty | 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": "The instance cannot be found.",
"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.