调用ListTraces查询指定主题的轨迹消息列表-云消息队列 RocketMQ 版-阿里云

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

rocketmq:ListTraces

get

*Topic

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

无

请求语法

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

路径参数

名称	类型	必填	描述	示例值
instanceId	string	是	实例 ID。	rmq-cn-tl32upjeb08
topicName	string	是	主题名称。	topic_hpms_product_price_change

请求参数

名称	类型	必填	描述	示例值
startTime	string	是	开始时间。	2023-05-10 10:42:11
endTime	string	是	结束时间。	2023-05-19 10:10:09
pageNumber	integer	是	分页页码，查询第几页的返回结果。	1
pageSize	integer	是	分页大小，每页做多显示的返回结果数量。	10
queryType	string	是	查询类型。枚举值： MESSAGE_ID : MESSAGE_ID MESSAGE_KEY : MESSAGE_KEY TOPIC : TOPIC	MESSAGE_ID
messageId	string	否	消息 ID。 queryType 选择 MESSAGE_ID 时必填。	0100163E0EC1F1965C04C7906700000000
messageKey	string	否	消息 key。 queryType 选择 MESSAGE_KEY 时必填。	order_ceating
liteTopicName	string	否	轻量主题名称	abc

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	Id of the request	EDFF77E1-1ED1-5389-B6A8-651D9433BBE5
success	boolean	执行结果是否成功。	true
code	string	错误码。	Topic.NotFound
message	string	错误信息。	Parameter instanceId is mandatory for this action .
data	object	返回结果。
pageNumber	integer	当前页码。	1
pageSize	integer	分页大小。	10
totalCount	integer	返回结果的总数量。	1
list	array<object>	分页数据。
	object	分页数据。
regionId	string	地域 ID。	cn-hangzhou
instanceId	string	实例 ID。	rmq-cn-7e22ody****
topicName	string	主题名称。	topic_test
messageId	string	消息 ID。	7F00000100207A4F0F294A938F7807AE
bornTime	string	生成时间。	2023-03-22 12:17:08
messageTag	string	标签列表。	xx
messageKeys	array	业务标识。
	string	业务标识。	xx
httpStatusCode	integer	HTTP 状态码。	200
dynamicCode	string	动态错误码。	InstanceId
dynamicMessage	string	动态错误信息。	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"
}

错误码

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

变更历史

更多信息，参考变更详情。