Debug Message Traces via ListTraces API - ApsaraMQ for RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

Queries the list of message traces under a specified topic.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

rocketmq:ListTraces

get

*Topic

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	rmq-cn-tl32upjeb08
topicName	string	Yes	The topic name.	topic_hpms_product_price_change

Request parameters

Parameter	Type	Required	Description	Example
startTime	string	Yes	The start time in YYYY-MM-DD HH:mm:ss format.	2023-05-10 10:42:11
endTime	string	Yes	The end time in YYYY-MM-DD HH:mm:ss format.	2023-05-19 10:10:09
pageNumber	integer	Yes	The page number of the returned results.	1
pageSize	integer	Yes	The number of results to display per page.	10
queryType	string	Yes	The query type. Valid values: MESSAGE_ID : MESSAGE_ID MESSAGE_KEY : MESSAGE_KEY TOPIC : TOPIC	MESSAGE_ID
messageId	string	No	The message ID. Required if queryType is set to MESSAGE_ID.	0100163E0EC1F1965C04C7906700000000
messageKey	string	No	The message key. Required if queryType is set to MESSAGE_KEY.	order_ceating
liteTopicName	string	No	The lightweight topic name.	abc

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	Id of the request	EDFF77E1-1ED1-5389-B6A8-651D9433BBE5
success	boolean	Indicates whether the request was successful.	true
code	string	The error code.	Topic.NotFound
message	string	The error message.	Parameter instanceId is mandatory for this action .
data	object	The returned results.
pageNumber	integer	The current page number.	1
pageSize	integer	The page size.	10
totalCount	integer	The total number of returned results.	1
list	array<object>	The paginated data.
	object	The paginated data.
regionId	string	The region ID.	cn-hangzhou
instanceId	string	The instance ID.	rmq-cn-7e22ody****
topicName	string	The topic name.	topic_test
messageId	string	The message ID.	7F00000100207A4F0F294A938F7807AE
bornTime	string	The time when the message was generated, in YYYY-MM-DD HH:mm:ss format.	2023-03-22 12:17:08
messageTag	string	The list of tags.	xx
messageKeys	array	The message key.
	string	The message key.	xx
httpStatusCode	integer	The HTTP status code.	200
dynamicCode	string	The dynamic error code.	InstanceId
dynamicMessage	string	The dynamic error message.	InstanceId

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.