ListTopics - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Queries the topics in a specified instance.

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:ListTopics	list	Topic `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/`	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The ID of the instance that contains the topics.	rmq-cn-7e22ody****
filter	string	No	The condition that you want to use to filter topics in the instance. If you leave this parameter empty, all topics in the instance are queried.	topic_test
pageNumber	integer	Yes	The number of the page to return.	1
pageSize	integer	Yes	The number of entries to return on each page.	3
messageTypes	array	No	The message types of the topics.
	string	No	The message type by which you want to query topics. If you leave this parameter empty, all topics in the instance are queried. Valid values: TRANSACTION: transactional message FIFO: ordered message DELAY: scheduled or delayed message NORMAL: normal message	NORMAL

Response parameters

Parameter	Type	Description	Example
	object	Result<MyPage>
requestId	string	The ID of the request. The system generates a unique ID for each request. You can troubleshoot issues based on the request ID.	AF9A8B10-C426-530F-A0DD-96320B39****
success	boolean	Indicates whether the call is successful.	true
data	object	The result data that is returned.
pageNumber	long	The page number of the returned page.	1
pageSize	long	The number of entries returned per page.	3
totalCount	long	The total number of returned entries.	1
list	array<object>	The paginated data.
list	object
regionId	string	The ID of the region in which the instance resides.	cn-hangzhou
instanceId	string	The ID of the instance.	rmq-cn-7e22ody****
topicName	string	The name of the topic.	topic_test
messageType	string	The message type of the topic. Valid values: TRANSACTION : transactional message FIFO : ordered message DELAY : scheduled or delayed message NORMAL : normal message	NORMAL
status	string	The state of the topic. Valid values: RUNNING : The topic is running . CREATING : The topic is being created .	RUNNING
remark	string	The remarks on the topic.	This is the remark for test.
createTime	string	The time when the topic was created.	2022-08-01 20:05:50
updateTime	string	The time when the topic was last updated.	2022-08-01 20:05:50
code	string	The error code.	Topic.NotFound
message	string	The error message.	The topic cannot be found.
httpStatusCode	integer	The HTTP status code.	400
dynamicCode	string	The dynamic error code.	TopicName
dynamicMessage	string	The dynamic error message.	topicName

Examples

Sample success responses

JSONformat

{
  "requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 3,
    "totalCount": 1,
    "list": [
      {
        "regionId": "cn-hangzhou",
        "instanceId": "rmq-cn-7e22ody****",
        "topicName": "topic_test",
        "messageType": "NORMAL",
        "status": "RUNNING",
        "remark": "This is the remark for test.",
        "createTime": "2022-08-01 20:05:50",
        "updateTime": "2022-08-01 20:05:50"
      }
    ]
  },
  "code": "Topic.NotFound",
  "message": "The topic cannot be found.",
  "httpStatusCode": 400,
  "dynamicCode": "TopicName",
  "dynamicMessage": "topicName"
}

Error codes

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

Change history

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