ListTraces - - Alibaba Cloud Documentation Center

Queries the message traces of a specific topic.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
rocketmq:ListTraces	get	*Topic `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}`	none	none

Request syntax

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

Request 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
startTime	string	Yes	The beginning of the time range to query.	2023-05-10 10:42:11
endTime	string	Yes	The end of the time range to query.	2023-05-19 10:10:09
pageNumber	integer	Yes	The page number.	1
pageSize	integer	Yes	The number of entries per page.	10
queryType	string	Yes	The query type. Valid values: MESSAGE_ID MESSAGE_KEY TOPIC	MESSAGE_ID
messageId	string	No	The message ID. This parameter is required if you set queryType to MESSAGE_ID.	0100163E0EC1F1965C04C7906700000000
messageKey	string	No	The message key. This parameter is required if you set queryType to MESSAGE_ID.	order_ceating

Response parameters

Parameter	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 result.
pageNumber	long	The page number of the returned page.	1
pageSize	long	The number of entries per page.	10
totalCount	long	The total number of returned entries.	1
list	array<object>	Trace list.
list	object	Trace list.
regionId	string	The region ID.	cn-hangzhou
instanceId	string	The instance ID.	rmq-cn-7e22ody****
topicName	string	The name of the topic.	topic_test
messageId	string	Message id.	7F00000100207A4F0F294A938F7807AE
bornTime	string	Message born time.	2023-03-22 12:17:08
messageTag	string	Message tag.	xx
messageKeys	array	Message keys.
messageKey	string	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

Sample success responses

JSONformat

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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-09-19	The internal configuration of the API is changed, but the call is not affected	View Change Details