Creates a topic.

  • 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 specifications of the instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateTopic

The operation that you want to perform. Set the value to CreateTopic.

InstanceId String Yes alikafka_pre-cn-mp919o4v****

The ID of the Message Queue for Apache Kafka instance in which you want to create a topic.

Topic String Yes alikafka_topic_test

The name of the topic.

  • The name can consist of 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.
  • The name cannot be modified after the topic is created.
Remark String Yes alikafka_topic_test

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.
RegionId String Yes cn-hangzhou

The ID of the region where the Message Queue for Apache Kafka instance is deployed

CompactTopic Boolean No false

The log cleanup policy that is used for the topic. When you specify true as the value of the LocalTopic parameter, this parameter takes effect. Valid values:

  • false: The topic uses the log delete policy.
  • true: The topic uses the log compaction policy.
PartitionNum String No 12

The number of partitions of the topic.

  • Valid values: 1 to 360.
  • In the Message Queue for Apache Kafka console, you can view the number of partitions that the system recommends based on the specifications of the instance. 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.
  • If you require more than 360 partitions for the topic, submit a ticket.
LocalTopic Boolean No false

The storage engine of the topic. Valid values:

  • false: The topic uses the cloud storage.
  • true: The topic uses the local storage.
ReplicationFactor Long No 3

The number of replicas of the topic.

  • This parameter takes effect only when you set the value of the LocalTopic parameter to true.
  • Valid values: 1 to 3.
Note If you set the value of this parameter to 1, the risk of data loss increases. Make sure that you are fully aware of the impact on your business.
MinInsyncReplicas Long No 1

The minimum number of in-sync replicas (ISRs).

  • This parameter takes effect only when you set the value of the LocalTopic parameter to true.
  • The value of this parameter must be smaller than the value of the ReplicationFactor parameter.
  • Valid values: 1 to 3.
Config Map No null

Additional configurations.

  • The value of this parameter must be in the JSON format.
  • The key must be replications. The value specifies the number of replicas of the topic. The value must be an integer ranging from 1 to 3.
  • This parameter takes effect only when you set the value of the LocalTopic parameter to true.
Note If you specify this parameter, the ReplicationFactor parameter does not take effect.

Response parameters

Parameter Type Example Description
Code Integer 200

The HTTP status code returned. The HTTP status code 200 indicates that the request is successful.

Message String operation success

The message returned.

RequestId String 9C0F207C-77A6-43E5-991C-9D98510A****

The ID of the request.

Success Boolean true

Indicates whether the request is successful.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateTopic
&InstanceId=alikafka_pre-cn-mp919o4v****
&RegionId=cn-hangzhou
&Remark=alikafka_topic_test
&Topic=alikafka_topic_test
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateTopicResponse>
    <RequestId>9C0F207C-77A6-43E5-991C-9D98510A****</RequestId>
    <Message>operation success</Message>
    <Code>200</Code>
    <Success>true</Success>
</CreateTopicResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, visit the API Error Center.