GetTrace - 获取消息轨迹

获取指定主题下的指定消息轨迹。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rocketmq:GetTraceget
*Topic
acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}

请求语法

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

请求参数

名称类型必填描述示例值
instanceIdstring

待查询实例的 ID。

rmq-cn-zvp2vtypu05
topicNamestring

待查询主题的名称。

linkedcare-image
messageIdstring

消息 id

012A5AB0BBEC8A000104C6342B00001ECF

返回参数

名称类型描述示例值
object

result

requestIdstring

请求 ID,每个请求的 ID 都是唯一的,可用于排查和定位问题。

7779A8FC-1BCD-5A1D-A603-C4A9BD8ADC49
successboolean

执行结果是否成功。

true
dataobject

返回结果。

regionIdstring

区域 ID。

cn-hangzhou
instanceIdstring

实例 ID。

rmq-cn-7e22ody****
topicNamestring

主题名称。

topic_test
messageInfoobject

消息信息。

regionIdstring

区域 ID。

cn-beijing
instanceIdstring

实例 ID。

rmq-cn-u0t2ygjq505
topicNamestring

主题名称。

Topic_normal_inspector
messageIdstring

消息 id

0A79275A00207A4F0F2916C92F9A0B94
bornTimestring

生成时间

2023-03-22 12:17:08
storeTimestring

存储时间

2023-03-22 12:17:08
bodystring

消息体。

{}
bornHoststring

消息来自哪里。

x.x.x.x
storeHoststring

消息存储位置

x.x.x.x
messageTypestring

消息类型。

NORMAL
messageTagstring

标签列表。

xx
messageGroupstring

以前的 shardingkey,顺序消息独有。

xx
messageKeysarray

业务标识。

messageKeystring

业务标识。

xx
userPropertiesobject

用户属性。

string

用户属性。

xx
transactionIdstring

事务标识。

xx
producerInfoobject

生产者轨迹信息。

recordsarray<object>

生产记录列表。

recordobject

生产记录列表。

userNamestring

生产者名称。

xxx
clientHoststring

主机名。

xx.xx.xx.xx
produceTimestring

发送时间。

2023-03-22 12:17:08
produceDurationlong

发送耗时。

100
produceStatusstring

发送状态。

SUCCESS
arriveTimestring

到达时间。

2023-03-22 12:17:08
messageSourcestring

消息来源。

CONSOLE
dlqOriginTopicstring

死信队列主题。

test_topic
dlqOriginMessageIdstring

死信队列消息 ID。

0A79275A00207A4F0F2916C92F9A0B94
brokerInfoobject

Broker 轨迹信息。

presetDelayTimestring

预设投递时间。

2023-03-22 12:17:08
delayStatusstring

定时状态。

SUCCESS
operationsarray<object>

操作列表。

operationobject

操作列表。

operateTypestring

操作类型。

ADD
operateTimestring

操作时间。

2023-03-22 12:17:08
consumerInfosarray<object>

消费者轨迹信息。

consumerInfoobject

消费者轨迹信息。

consumerGroupIdstring

消费组 ID。

GID_inspector_group
recordsarray<object>

消费记录列表。

recordobject

消费记录列表。

userNamestring

消费者名称。

test
clientHoststring

主机名。

xx.xx.xx.xx
fifoEnableboolean

是否顺序消费。

true
consumeStatusstring

消费状态。

SUCCESS
operationsarray<object>

操作列表。

operationobject

操作列表。

operateTypestring

操作类型。

ADD
operateTimestring

操作时间。

2023-03-22 12:17:08
invisibleTimelong

不可见时间,毫秒。

100
deadMessageboolean

是否为死信。

true
popCkstring

POP_CK

123
consumeStatusstring

消费状态。

SUCCESS
deadMessageboolean

是否为死信。

true
deadLetterInfoobject

死信信息。

topicNamestring

主题名称。

Register_Sync
messageIdstring

消息 ID。

7F000001001F7A4F0F29463F0376047D
toDlqTimestring

到达死信队列时间。

2023-03-22 12:17:08
codestring

错误码。

InvalidConsumerGroupId
messagestring

错误信息。

The instance cannot be found.
httpStatusCodeinteger

HTTP 状态码。

200
dynamicCodestring

动态错误码。

InstanceId
dynamicMessagestring

动态错误信息。

instanceId

示例

正常返回示例

JSON格式

{
  "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"
    },
    "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"
        }
      ]
    },
    "brokerInfo": {
      "presetDelayTime": "2023-03-22 12:17:08",
      "delayStatus": "SUCCESS",
      "operations": [
        {
          "operateType": "ADD",
          "operateTime": "2023-03-22 12:17:08"
        }
      ]
    },
    "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"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-10-10OpenAPI 返回结构发生变更查看变更详情
2024-09-19API 内部配置变更,不影响调用查看变更详情