OnsTopicCreate - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Operation description

Important Alibaba Cloud OpenAPI is a management API. You can use it to manage and query Alibaba Cloud resources. Integrate OpenAPI for management purposes only. Do not use it for core data links that send and receive messages because this can threaten the security of your data links.

You can call this operation to create a topic for a new application or business extension.

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

mq:CreateTopic

*Topic

acs:mq:{#regionId}:{#accountId}:{#TopicName}

*Topic

acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}

None

mq:QueryInstanceBaseInfo

Request parameters

Parameter	Type	Required	Description	Example
Topic	string	Yes	The name of the topic to create. The name must meet the following requirements: The name must be 3 to 64 characters long. It can contain only letters, digits, hyphens (-), and underscores (_). The name cannot start with CID or GID. These prefixes are reserved for group IDs. If the instance has a namespace, the topic name must be unique within the instance. The name cannot match an existing topic name or group ID in the same instance. However, topic names can be reused across different instances. For example, a topic in instance A can have the same name as a topic in instance B. If the instance does not have a namespace, the topic name must be globally unique across all instances and regions. The name cannot match any existing topic name or group ID. Note To check if an instance has a namespace, go to the Instance Details page in the ApsaraMQ for RocketMQ console. The information is in the Basic Information section.	test
MessageType	integer	Yes	The message type. Valid values: 0: Normal message 1: Partitionally ordered message 4: Transactional message 5: Scheduled and delayed message For more information, see Message types.	0
Remark	string	No	The description of the topic.	测试
InstanceId	string	No	The ID of the instance where the topic resides.	MQ_INST_188077086902****_BXSuW61e

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The ID of the request. This ID is unique and can be used for troubleshooting.	B6949B58-223E-4B75-B4FE-7797C15E****

Examples

Success response

JSON format

{
  "RequestId": "B6949B58-223E-4B75-B4FE-7797C15E****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	%s	%s, please check and retry later

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.