GetTopic - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Retrieves the details of 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:GetTopic

get

*Topic

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The ID of the instance to which the topic belongs.	rmq-cn-7e22ody****
topicName	string	Yes	The name of the topic.	topic_test

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	Result
requestId	string	The ID of the request. This ID is unique to each request. Use this ID to troubleshoot issues.	AF9A8B10-C426-530F-A0DD-96320B39****
success	boolean	Indicates whether the request was successful.	true
data	object	The data returned.
regionId	string	The ID of the region to which the instance belongs.	cn-hangzhou
instanceId	string	The ID of the instance to which the topic belongs.	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 message or delayed message NORMAL : normal message	NORMAL
status	string	The status of the topic. Valid values: RUNNING: The topic is running. CREATING: The topic is being created. 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 transactions per second (TPS) for sending messages.	1000
liteTopicExpiration	integer	The expiration time of the lite topic. Unit: minutes.	60
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": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "topicName": "topic_test",
    "messageType": "NORMAL",
    "status": "RUNNING",
    "remark": "This is the remark for test.\n",
    "createTime": "2022-08-01 20:05:50",
    "updateTime": "2022-08-01 20:05:50",
    "maxSendTps": 1000,
    "liteTopicExpiration": 60
  },
  "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.