CreateTopic - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Creates a topic.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:CreateTopic	Write	Topic acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}	none	none

Request syntax

POST /instances/{instanceId}/topics/{topicName}

Request 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. The name is used to identify the topic and is globally unique in the instance. The following describes the naming conventions of a topic: The name can contain letters, digits, underscores (_), hyphens (-), and percent signs (%). The name must be 1 to 60 characters in length. For information about the characters reserved for the system, see Limits on parameters.	topic_test
body	object	No	The message type.
messageType	string	No	The type of messages in the topic that you want to create. Valid values: TRANSACTION: transactional messages FIFO: ordered messages DELAY: scheduled messages or delayed Message NORMAL: normal messages Note The type of messages in the topic must be the same as the type of messages that you want to send. For example, if you create a topic whose message type is ordered messages, the topic can be used to send and receive only ordered messages.	NORMAL
remark	string	No	The description of the topic that you want to create.	This is the remark for test.

Response parameters

Parameter	Type	Description	Example
	object	Result
requestId	string	The ID of the request. Each request has a unique ID. You can use this ID to troubleshoot issues.	AF9A8B10-C426-530F-A0DD-96320B39****
success	boolean	Indicates whether the call was successful.	true
data	boolean	The returned result.	true
code	string	The error code returned if the call failed.	Topic.Existed
message	string	The error message.	The topic already exists.
httpStatusCode	integer	The HTTP status code returned.	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": true,
  "code": "Topic.Existed",
  "message": "The topic already exists.",
  "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

No change history