ListTopics - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Queries the topics in a specified instance.

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:ListTopics

list

*Topic

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The ID of the instance whose topics you want to query.	rmq-cn-7e22ody****

Request parameters

Parameter	Type	Required	Description	Example
filter	string	No	The filter condition. If you leave this parameter empty, all topics in the instance are queried.	topic_test
pageNumber	integer	No	The page number of the page to return.	1
pageSize	integer	No	The number of entries to return on each page.	3
messageTypes	array	No	The message types of the topics.
	string	No	The message type of the topics to query. If you leave this parameter empty, topics of all message types are queried. Valid values: TRANSACTION: transactional message FIFO: ordered message DELAY: scheduled or delayed message NORMAL: normal message LITE: lightweight topic Valid values: TRANSACTION : Transactional message FIFO : Ordered message DELAY : Scheduled and delayed message NORMAL : Normal message	NORMAL

Response elements

Element	Type	Description	Example
	object	Result<MyPage>
requestId	string	The request ID. This ID is unique to each request and can be used to troubleshoot issues.	AF9A8B10-C426-530F-A0DD-96320B39****
success	boolean	Indicates whether the request was successful.	true
data	object	The returned data.
pageNumber	integer	The page number of the returned page.	1
pageSize	integer	The number of entries returned per page.	3
totalCount	integer	The total number of returned entries.	1
list	array<object>	The paginated data.
	object
regionId	string	The ID of the region where the instance resides.	cn-hangzhou
instanceId	string	The instance ID.	rmq-cn-7e22ody****
topicName	string	The topic name.	topic_test
messageType	string	The message type of the topic. Valid values: TRANSACTION : Transactional message FIFO : Ordered message DELAY : Scheduled and delayed messages NORMAL : Normal message	NORMAL
status	string	The status of the topic. Valid values: RUNNING : Running CREATING : Creating	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 modified.	2022-08-01 20:05:50
maxSendTps	integer	The maximum number of messages that can be sent per second.	1000
liteTopicExpiration	integer	The expiration time of the lightweight topic. Unit: minutes.	20
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

Success response

JSON format

{
  "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",
        "maxSendTps": 1000,
        "liteTopicExpiration": 20
      }
    ]
  },
  "code": "Topic.NotFound",
  "message": "The topic cannot be found.",
  "httpStatusCode": 400,
  "dynamicCode": "TopicName",
  "dynamicMessage": "topicName"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.