CreateTopic

Last updated: 2025-11-21 20:32:27

CreateTopic

Last updated: 2025-11-21 20:32:27

1. API Description

Domain name for API request: ckafka.intl.tencentcloudapi.com.

This API is used to create a CKafka topic.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: CreateTopic.
Version	Yes	String	Common Params. The value used for this API: 2019-08-19.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	Instance Id. you can obtain it by calling the DescribeInstances api.
TopicName	Yes	String	Can only contain letters, digits, underscores, "-", or ".".
PartitionNum	Yes	Integer	Number of partitions, which should be greater than 0
ReplicaNum	Yes	Integer	Number of replicas, which cannot be higher than the number of brokers. Maximum value: 3
EnableWhiteList	No	Integer	IP allowlist switch. 1: enabled, 0: disabled. Default value: 0
IpWhiteList.N	No	Array of String	IP allowlist list for quota limit, which is required if `enableWhileList` is 1
CleanUpPolicy	No	String	Log cleanup policy, which is `delete` by default. `delete`: logs will be deleted by save time; `compact`: logs will be compressed by key; `compact, delete`: logs will be compressed by key and deleted by save time.
Note	No	String	Topic remark is a string of no more than 64 characters. the first character can be a letter or digit, and the remaining part can contain letters, digits, and hyphens (-).
MinInsyncReplicas	No	Integer	Minimum number of synchronous replicas, defaults to 1.
UncleanLeaderElectionEnable	No	Integer	Whether to allow unsynchronized replicas to be elected as leader. valid values: 0 (not allowed), 1 (allowed). default: not allowed.
RetentionMs	No	Integer	Optional parameter. specifies the message retention period in milliseconds. current min value is 60000. default value is 7200000 ms (2 hours). maximum value is 7776000000 ms (90 days).
SegmentMs	No	Integer	Duration of Segment shard scrolling in milliseconds. minimum value is 86400000 ms (1 day).
MaxMessageBytes	No	Integer	Maximum topic messages in Bytes. value range: 1024 (1 KB) to 12582912 (12 MB).
EnableAclRule	No	Integer	Preset ACL rule. `1`: enable, `0`: disable. Default value: `0`.
AclRuleName	No	String	Name of the preset ACL rule.
RetentionBytes	No	Integer	Optional. retain file size. defaults to -1, unit Byte. current min value is 1073741824.
Tags.N	No	Array of Tag	Tag list.
LogMsgTimestampType	No	String	Time type for message saving. valid values: CreateTime/LogAppendTime.

3. Output Parameters

Parameter Name	Type	Description
Result	CreateTopicResp	Returned creation result
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Create topics.

Input Example

https://ckafka.intl.tencentcloudapi.com/?Action=CreateTopic
&InstanceId=ckafka-test
&TopicName=topic-name
&PartitionNum=1
&ReplicaNum=2
&<Common request parameters>

Output Example

{
    "Response": {
        "Result": {
            "TopicId": "topic-k766ruye"
        },
        "RequestId": "1305a410-b030-476d-acdf-eba0dfd5323b"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation	Operation failed.
InternalError	Internal error.
InvalidParameter	Invalid parameter.
InvalidParameterValue.InstanceNotExist	The instance does not exist.
InvalidParameterValue.RepetitionValue	The parameter already exists.
InvalidParameterValue.SubnetIdInvalid	Invalid subnet ID.
InvalidParameterValue.SubnetNotBelongToZone	The subnet is not in the zone.
InvalidParameterValue.TopicNameAlreadyExist	Topic name already exists.
InvalidParameterValue.VpcIdInvalid	Invalid VPC ID.
InvalidParameterValue.WrongAction	The value of the `Action` parameter is incorrect.
InvalidParameterValue.ZoneNotSupport	The zone is not supported.
LimitExceeded	The quota limit has been reached.
ResourceUnavailable	The resource is unavailable.
UnauthorizedOperation	Unauthorized operation.
UnsupportedOperation	Unsupported operation.
UnsupportedOperation.BatchDelInstanceLimit	The batch instance deletion limit is reached.
UnsupportedOperation.OssReject	Oss rejected the operation.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud