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.
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 For reference: DescribeInstances |
| TopicName | Yes | String | Can only contain letters, digits, underscore, "-", ".". |
| PartitionNum | Yes | Integer | Number of partitions, more than 0 |
| ReplicaNum | Yes | Integer | Replica count cannot be over the number of brokers, with a maximum of 3 |
| EnableWhiteList | No | Integer | ip allowlist switch, 1: on; 0: off, default off |
| IpWhiteList.N | No | Array of String | Ip whitelist, Quota limit, essential when enableWhileList=1 |
| CleanUpPolicy | No | String | Log cleanup policy. Log cleanup mode, defaults to "delete". "delete": logs are deleted by retention time. "compact": logs are compressed by key. "compact, delete": logs are compressed by key and deleted by retention time. |
| Note | No | String | Topic remark Input parameter limit: No more than 64 characters |
| MinInsyncReplicas | No | Integer | Minimum sync replica count Default value: 1 Minimum value: 1 |
| UncleanLeaderElectionEnable | No | Integer | Whether to allow unsynchronized replicas to be elected as leader, 0: not allowed, 1: allowed, default not allowed |
| RetentionMs | No | Integer | Optional parameter, message retention period Value ranges from 60000 to 7776000000 Unit: ms Default value: 7200000 |
| SegmentMs | No | Integer | Duration of Segment shard scrolling Unit: ms Default value: 86400000 Minimum value: 86400000ms (1 day) |
| MaxMessageBytes | No | Integer | Maximum topic messages in Bytes, minimum value 1024 Bytes (1 KB), maximum value 12582912 Bytes (12 MB) |
| EnableAclRule | No | Integer | Preset ACL rule, 1: on 0: off, default is off |
| AclRuleName | No | String | Preset ACL rule name |
| RetentionBytes | No | Integer | Option, retain file size. Defaults to -1, unit Byte, current min value is 1073741824. Value ranges from [1073741824, 1099511627776] Unit: Byte Special value: -1 indicates unlimited |
| Tags.N | No | Array of Tag | Tag list |
| LogMsgTimestampType | No | String | Time type for message saving: CreateTime/LogAppendTime |
| Parameter Name | Type | Description |
|---|---|---|
| Result | CreateTopicResp | Return 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. |
https://ckafka.intl.tencentcloudapi.com/?Action=CreateTopic
&InstanceId=ckafka-test
&TopicName=topic-name
&PartitionNum=1
&ReplicaNum=2
&<Common request parameters>
{
"Response": {
"Result": {
"TopicId": "topic-k766ruye"
},
"RequestId": "1305a410-b030-476d-acdf-eba0dfd5323b"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
フィードバック