CreateTopic - ApsaraMQ for Kafka - Alibaba Cloud Documentation Center

Creates a topic.

Operation description

Each Alibaba Cloud account can call this operation up to once per second.
The maximum number of topics that you can create in an instance is determined by the specification of the instance.

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
alikafka:CreateTopic	Write	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	alikafka_pre-cn-mp919o4v****
Topic	string	Yes	The topic name. The name can contain only letters, digits, hyphens (-), and underscores (_). The name must be 3 to 64 characters in length. If the name that you specify contains more than 64 characters, the system automatically truncates the name. After a topic is created, you cannot change the name of the topic.	alikafka_topic_test
Remark	string	Yes	The description of the topic. The description can contain only letters, digits, hyphens (-), and underscores (_). The description must be 3 to 64 characters in length.	alikafka_topic_test
RegionId	string	Yes	The region ID of the instance in which you want to create a topic.	cn-hangzhou
CompactTopic	boolean	No	The log cleanup policy that is used for the topic. This parameter is available only when LocalTopic is set to true. Valid values: false: The topic uses the default log cleanup policy. true: The topic uses the log compaction policy.	false
PartitionNum	string	No	The number of partitions in the topic. Valid values: 1 to 360. The system recommends the number of partitions based on the specification of the instance. You can view the recommended number in the Message Queue for Apache Kafka console. We recommend that you specify the number that is recommended by the system as the value of this parameter to reduce the risk of data skew.	12
LocalTopic	boolean	No	The type of storage that the topic uses. Valid values: false: The topic uses cloud storage. true: The topic uses local storage.	false
ReplicationFactor	long	No	The number of replicas for the topic. This parameter is available only when LocalTopic is set to true, or the instance is of the Open Source Edition (Local Disk).** Valid values: 1 to 3. Note** If you set this parameter to 1, data loss may occur. Exercise caution when you configure this parameter.	3
MinInsyncReplicas	long	No	The minimum number of in-sync replicas (ISRs). This parameter is available only when LocalTopic is set to true, or the instance is of the Open Source Edition (Local Disk).**** The value of this parameter must be smaller than the value of ReplicationFactor. Valid values: 1 to 3.	1
Config	string	No	The additional configurations. The value of this parameter must be in JSON format. The key must be replications. The value indicates the number of replicas for the topic. The value must be an integer that ranges from 1 to 3. This parameter is available only when LocalTopic is set to true, or the instance is of the Open Source Edition (Local Disk).** Note If you specify this parameter, ReplicationFactor** does not take effect.	{"replications": 3}
Tag	object []	No	The tags that you want to add to the topic.
Key	string	Yes	The tag key. If you do not specify this parameter, the keys of all tags are matched. The tag key must be 1 to 128 characters in length and cannot contain `http://` or `https://`. The tag key cannot start with `aliyun` or `acs:`.	FinanceDept
Value	string	No	The tag value. You can leave this parameter empty. The tag value must be 1 to 128 characters in length and cannot contain http:// or https://. The tag value cannot start with aliyun or acs:.	FinanceJoshua

Response parameters

Parameter	Type	Description	Example
	object
Code	integer	The HTTP status code returned. The HTTP status code 200 indicates that the call is successful.	200
Message	string	The message returned.	operation success
RequestId	string	The request ID.	9C0F207C-77A6-43E5-991C-9D98510A****
Success	boolean	Indicates whether the call was successful.	true

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "operation success",
  "RequestId": "9C0F207C-77A6-43E5-991C-9D98510A****",
  "Success": true
}

Error codes

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

Change history

Change time

Summary of changes

Operation

2023-01-06

The internal configuration of the API is changed, but the call is not affected

see changesets

Change item	Change content
	The internal configuration of the API is changed, but the call is not affected.

2022-10-28

The request parameters of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: Tag

2021-11-17

The request parameters of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: ReplicationFactor
	Added Input Parameters: MinInsyncReplicas
	Added Input Parameters: Config