ListTraces - 查询轨迹消息列表

查询指定主题下的轨迹消息列表。

调试

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

授权信息

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

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

请求语法

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

请求参数

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

实例 ID。

rmq-cn-tl32upjeb08
topicNamestring

主题名称。

topic_hpms_product_price_change
startTimestring

开始时间。

2023-05-10 10:42:11
endTimestring

结束时间。

2023-05-19 10:10:09
pageNumberinteger

分页页码,查询第几页的返回结果。

1
pageSizeinteger

分页大小,每页做多显示的返回结果数量。

10
queryTypestring

查询类型。

枚举值:
  • MESSAGE_IDMESSAGE_ID
  • MESSAGE_KEYMESSAGE_KEY
  • TOPICTOPIC
MESSAGE_ID
messageIdstring

消息 ID。

queryType 选择 MESSAGE_ID 时必填。

0100163E0EC1F1965C04C7906700000000
messageKeystring

消息 key。

queryType 选择 MESSAGE_KEY 时必填。

order_ceating

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

Id of the request

EDFF77E1-1ED1-5389-B6A8-651D9433BBE5
successboolean

执行结果是否成功。

true
codestring

错误码。

Topic.NotFound
messagestring

错误信息。

Parameter instanceId is mandatory for this action .
dataobject

返回结果。

pageNumberlong

当前页码。

1
pageSizelong

分页大小。

10
totalCountlong

返回结果的总数量。

1
listarray<object>

分页数据。

listobject

分页数据。

regionIdstring

地域 ID。

cn-hangzhou
instanceIdstring

实例 ID。

rmq-cn-7e22ody****
topicNamestring

主题名称。

topic_test
messageIdstring

消息 ID。

7F00000100207A4F0F294A938F7807AE
bornTimestring

生成时间。

2023-03-22 12:17:08
messageTagstring

标签列表。

xx
messageKeysarray

业务标识。

messageKeystring

业务标识。

xx
httpStatusCodeinteger

HTTP 状态码。

200
dynamicCodestring

动态错误码。

InstanceId
dynamicMessagestring

动态错误信息。

InstanceId

示例

正常返回示例

JSON格式

{
  "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"
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-09-19API 内部配置变更,不影响调用查看变更详情