# Tencent Cloud Message Queue CKafka API

> Tencent Cloud Message Queue CKafka API on Apizie: 105 endpoints (Associate Routes Security Group, Authorize Token, Batch Create Acl, Batch Modify Group Offsets, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:tencent-ckafka/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:tencent-ckafka`
- Category: Cloud
- Status: byok
- Source: https://www.tencentcloud.com/document/api
- Page: https://apizie.tech/api/cloud/tencent-ckafka
- OpenAPI: https://apizie.tech/api/cloud/tencent-ckafka/openapi.json

Tencent Cloud API 3.0 for Message Queue CKafka (ckafka). Every call is signed with TC3-HMAC-SHA256 using your SecretId and SecretKey.

## Endpoints

### Associate Routes Security Group
`POST https://apizie.tech/v1/cloud:tencent-ckafka/associate-routes-security-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceRoutes | array | yes |  |
| SecurityGroupId | string | yes |  |

### Authorize Token
`POST https://apizie.tech/v1/cloud:tencent-ckafka/authorize-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| User | string | yes |  |
| Tokens | string | yes |  |

### Batch Create Acl
`POST https://apizie.tech/v1/cloud:tencent-ckafka/batch-create-acl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| ResourceType | integer | yes |  |
| ResourceNames | array | yes |  |
| RuleList | array | yes |  |

### Batch Modify Group Offsets
`POST https://apizie.tech/v1/cloud:tencent-ckafka/batch-modify-group-offsets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| GroupName | string | yes |  |
| InstanceId | string | yes |  |
| Partitions | array | yes |  |
| TopicName | array | no |  |

### Batch Modify Topic Attributes
`POST https://apizie.tech/v1/cloud:tencent-ckafka/batch-modify-topic-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| Topic | array | yes |  |

### Cancel Authorization Token
`POST https://apizie.tech/v1/cloud:tencent-ckafka/cancel-authorization-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| User | string | yes |  |
| Tokens | string | yes |  |

### Check Cdc Cluster
`POST https://apizie.tech/v1/cloud:tencent-ckafka/check-cdc-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| TaskId | integer | yes |  |

### Create Acl
`POST https://apizie.tech/v1/cloud:tencent-ckafka/create-acl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| ResourceType | integer | yes |  |
| Operation | integer | yes |  |
| PermissionType | integer | yes |  |
| ResourceName | string | no |  |
| Host | string | no |  |
| Principal | string | no |  |
| ResourceNameList | string | no |  |

### Create Acl Rule
`POST https://apizie.tech/v1/cloud:tencent-ckafka/create-acl-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| ResourceType | string | yes |  |
| PatternType | string | yes |  |
| RuleName | string | yes |  |
| RuleList | array | yes |  |
| Pattern | string | no |  |
| IsApplied | integer | no |  |
| Comment | string | no |  |

### Create Cdc Cluster
`POST https://apizie.tech/v1/cloud:tencent-ckafka/create-cdc-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CdcId | string | yes |  |
| CdcVpcId | string | yes |  |
| CdcSubnetId | string | yes |  |
| ZoneId | integer | yes |  |
| Bandwidth | integer | yes |  |
| DiskSize | integer | yes |  |
| DiskType | string | yes |  |
| SystemDiskType | string | yes |  |

### Create Connect Resource
`POST https://apizie.tech/v1/cloud:tencent-ckafka/create-connect-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ResourceName | string | yes |  |
| Type | string | yes |  |
| Description | string | no |  |
| DtsConnectParam | object | no |  |
| MongoDBConnectParam | object | no |  |
| EsConnectParam | object | no |  |
| ClickHouseConnectParam | object | no |  |
| MySQLConnectParam | object | no |  |
| PostgreSQLConnectParam | object | no |  |
| MariaDBConnectParam | object | no |  |
| SQLServerConnectParam | object | no |  |
| DorisConnectParam | object | no |  |
| KafkaConnectParam | object | no |  |
| MqttConnectParam | object | no |  |
| IcebergConnectParam | object | no |  |
| Tags | array | no |  |

### Create Consumer
`POST https://apizie.tech/v1/cloud:tencent-ckafka/create-consumer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| GroupName | string | yes |  |
| TopicName | string | no |  |
| TopicNameList | array | no |  |

### Create Datahub Task
`POST https://apizie.tech/v1/cloud:tencent-ckafka/create-datahub-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| TaskName | string | yes |  |
| TaskType | string | yes |  |
| SourceResource | object | no |  |
| TargetResource | object | no |  |
| TransformParam | object | no |  |
| SchemaId | string | no |  |
| TransformsParam | object | no |  |
| TaskId | string | no |  |
| Tags | array | no |  |
| Description | string | no |  |

### Create Datahub Topic
`POST https://apizie.tech/v1/cloud:tencent-ckafka/create-datahub-topic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| Name | string | yes |  |
| PartitionNum | integer | yes |  |
| RetentionMs | integer | yes |  |
| Note | string | no |  |
| Tags | array | no |  |

### Create Instance Pre
`POST https://apizie.tech/v1/cloud:tencent-ckafka/create-instance-pre` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceName | string | yes |  |
| ZoneId | integer | yes |  |
| Period | string | yes |  |
| InstanceType | integer | yes |  |
| VpcId | string | yes |  |
| SubnetId | string | yes |  |
| MsgRetentionTime | integer | no |  |
| ClusterId | integer | no |  |
| RenewFlag | integer | no |  |
| KafkaVersion | string | no |  |
| SpecificationsType | string | no |  |
| DiskSize | integer | no |  |
| BandWidth | integer | no |  |
| Partition | integer | no |  |
| Tags | array | no |  |
| DiskType | string | no |  |
| MultiZoneFlag | boolean | no |  |
| ZoneIds | array | no |  |
| PublicNetworkMonthly | integer | no |  |
| InstanceNum | integer | no |  |
| AutoVoucher | integer | no |  |
| ElasticBandwidthSwitch | integer | no |  |
| CustomSSLCertId | string | no |  |
| StoreQuantityType | integer | no |  |

### Create Meta And Data Sync Datahub Task
`POST https://apizie.tech/v1/cloud:tencent-ckafka/create-meta-and-data-sync-datahub-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| TaskName | string | yes |  |
| SourceResourceId | string | yes |  |
| TargetResourceId | string | yes |  |
| Tags | array | no |  |
| OffsetType | string | no |  |
| TopicRegularExpression | string | no |  |
| TopicList | array | no |  |
| Prefix | string | no |  |
| Separator | string | no |  |
| Description | string | no |  |

### Create Meta Data And Offset Sync Datahub Task
`POST https://apizie.tech/v1/cloud:tencent-ckafka/create-meta-data-and-offset-sync-datahub-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| TaskName | string | yes |  |
| SourceResourceId | string | yes |  |
| TargetResourceId | string | yes |  |
| Description | string | no |  |
| OffsetType | string | no |  |
| TopicRegularExpression | string | no |  |
| TopicList | array | no |  |
| Prefix | string | no |  |
| Separator | string | no |  |
| Tags | array | no |  |

### Create Meta Sync Datahub Task
`POST https://apizie.tech/v1/cloud:tencent-ckafka/create-meta-sync-datahub-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| TaskName | string | yes |  |
| SourceResourceId | string | yes |  |
| TargetResourceId | string | yes |  |
| Description | string | no |  |
| Tags | array | no |  |

### Create Partition
`POST https://apizie.tech/v1/cloud:tencent-ckafka/create-partition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| TopicName | string | yes |  |
| PartitionNum | integer | yes |  |

### Create Post Paid Instance
`POST https://apizie.tech/v1/cloud:tencent-ckafka/create-post-paid-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| VpcId | string | yes |  |
| SubnetId | string | yes |  |
| InstanceName | string | no |  |
| InstanceType | integer | no |  |
| MsgRetentionTime | integer | no |  |
| ClusterId | integer | no |  |
| KafkaVersion | string | no |  |
| SpecificationsType | string | no |  |
| DiskType | string | no |  |
| BandWidth | integer | no |  |
| DiskSize | integer | no |  |
| Partition | integer | no |  |
| TopicNum | integer | no |  |
| ZoneId | integer | no |  |
| MultiZoneFlag | boolean | no |  |
| ZoneIds | array | no |  |
| InstanceNum | integer | no |  |
| PublicNetworkMonthly | integer | no |  |
| Tags | array | no |  |
| ElasticBandwidthSwitch | integer | no |  |
| CustomSSLCertId | string | no |  |
| StoreQuantityType | integer | no |  |

### Create Prometheus
`POST https://apizie.tech/v1/cloud:tencent-ckafka/create-prometheus` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| VpcId | string | yes |  |
| SubnetId | string | yes |  |

### Create Route
`POST https://apizie.tech/v1/cloud:tencent-ckafka/create-route` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| VipType | integer | yes |  |
| VpcId | string | no |  |
| SubnetId | string | no |  |
| AccessType | integer | no |  |
| AuthFlag | integer | no |  |
| CallerAppid | integer | no |  |
| PublicNetwork | integer | no |  |
| Ip | string | no |  |
| Note | string | no |  |
| SecurityGroupIds | array | no |  |
| IpWhitelist | array | no |  |

### Create Throttle Rule
`POST https://apizie.tech/v1/cloud:tencent-ckafka/create-throttle-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| ThrottleType | integer | yes |  |
| GroupNameList | array | no |  |
| ConsumeThrottle | integer | no |  |
| ProduceThrottle | integer | no |  |
| ClientIdList | array | no |  |
| UserNameList | array | no |  |
| TopicNameList | array | no |  |

### Create Token
`POST https://apizie.tech/v1/cloud:tencent-ckafka/create-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| User | string | yes |  |

### Create Topic
`POST https://apizie.tech/v1/cloud:tencent-ckafka/create-topic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| TopicName | string | yes |  |
| PartitionNum | integer | yes |  |
| ReplicaNum | integer | yes |  |
| EnableWhiteList | integer | no |  |
| IpWhiteList | array | no |  |
| CleanUpPolicy | string | no |  |
| Note | string | no |  |
| MinInsyncReplicas | integer | no |  |
| UncleanLeaderElectionEnable | integer | no |  |
| RetentionMs | integer | no |  |
| SegmentMs | integer | no |  |
| MaxMessageBytes | integer | no |  |
| EnableAclRule | integer | no |  |
| AclRuleName | string | no |  |
| RetentionBytes | integer | no |  |
| Tags | array | no |  |
| LogMsgTimestampType | string | no |  |

### Create Topic Ip White List
`POST https://apizie.tech/v1/cloud:tencent-ckafka/create-topic-ip-white-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| TopicName | string | yes |  |
| IpWhiteList | array | yes |  |

### Create User
`POST https://apizie.tech/v1/cloud:tencent-ckafka/create-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| Name | string | yes |  |
| Password | string | no |  |

### Delete Acl
`POST https://apizie.tech/v1/cloud:tencent-ckafka/delete-acl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| ResourceType | integer | yes |  |
| ResourceName | string | yes |  |
| Operation | integer | yes |  |
| PermissionType | integer | yes |  |
| Host | string | no |  |
| Principal | string | no |  |

### Delete Acl Rule
`POST https://apizie.tech/v1/cloud:tencent-ckafka/delete-acl-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| RuleName | string | yes |  |

### Delete Connect Resource
`POST https://apizie.tech/v1/cloud:tencent-ckafka/delete-connect-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ResourceId | string | yes |  |

### Delete Datahub Task
`POST https://apizie.tech/v1/cloud:tencent-ckafka/delete-datahub-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| TaskId | string | yes |  |

### Delete Datahub Topic
`POST https://apizie.tech/v1/cloud:tencent-ckafka/delete-datahub-topic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| Name | string | yes |  |

### Delete Group
`POST https://apizie.tech/v1/cloud:tencent-ckafka/delete-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| Group | string | yes |  |

### Delete Group Subscribe Topic
`POST https://apizie.tech/v1/cloud:tencent-ckafka/delete-group-subscribe-topic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| Group | string | yes |  |
| Topic | string | yes |  |

### Delete Instance Post
`POST https://apizie.tech/v1/cloud:tencent-ckafka/delete-instance-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |

### Delete Instance Pre
`POST https://apizie.tech/v1/cloud:tencent-ckafka/delete-instance-pre` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |

### Delete Route
`POST https://apizie.tech/v1/cloud:tencent-ckafka/delete-route` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| RouteId | integer | yes |  |
| CallerAppid | integer | no |  |
| DeleteRouteTime | string | no |  |

### Delete Route Trigger Time
`POST https://apizie.tech/v1/cloud:tencent-ckafka/delete-route-trigger-time` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| DelayTime | string | yes |  |

### Delete Throttle Rule
`POST https://apizie.tech/v1/cloud:tencent-ckafka/delete-throttle-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ThrottleRuleId | string | yes |  |
| InstanceId | string | yes |  |

### Delete Topic
`POST https://apizie.tech/v1/cloud:tencent-ckafka/delete-topic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| TopicName | string | yes |  |

### Delete User
`POST https://apizie.tech/v1/cloud:tencent-ckafka/delete-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| Name | string | yes |  |

### Describe ACL
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-acl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| ResourceType | integer | yes |  |
| ResourceName | string | no |  |
| Offset | integer | no |  |
| Limit | integer | no |  |

### Describe Access Policy
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-access-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| RouteId | integer | yes |  |

### Describe Acl Rule
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-acl-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| RuleName | string | no |  |
| PatternType | string | no |  |
| IsSimplified | boolean | no |  |

### Describe Ckafka Version
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-ckafka-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |

### Describe Ckafka Zone
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-ckafka-zone` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CdcId | string | no |  |

### Describe Connect Resource
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-connect-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ResourceId | string | yes |  |

### Describe Connect Resources
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-connect-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| Type | string | no |  |
| SearchWord | string | no |  |
| Offset | integer | no |  |
| Limit | integer | no |  |
| ResourceRegion | string | no |  |

### Describe Consumer Group
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-consumer-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| GroupName | string | no |  |
| TopicName | string | no |  |
| Limit | integer | no |  |
| Offset | integer | no |  |

### Describe Cvm Info
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-cvm-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |

### Describe Datahub Group Offsets
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-datahub-group-offsets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| Name | string | yes |  |
| Group | string | yes |  |
| SearchWord | string | no |  |
| Offset | integer | no |  |
| Limit | integer | no |  |

### Describe Datahub Task
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-datahub-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| TaskId | string | yes |  |

### Describe Datahub Tasks
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-datahub-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| Limit | integer | no |  |
| Offset | integer | no |  |
| SearchWord | string | no |  |
| TargetType | string | no |  |
| TaskType | string | no |  |
| SourceType | string | no |  |
| Resource | string | no |  |

### Describe Datahub Topic
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-datahub-topic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| Name | string | yes |  |

### Describe Datahub Topics
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-datahub-topics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| SearchWord | string | no |  |
| Offset | integer | no |  |
| Limit | integer | no |  |
| QueryFromConnectResource | boolean | no |  |
| ConnectResourceId | string | no |  |
| TopicRegularExpression | string | no |  |

### Describe Group
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| SearchWord | string | no |  |
| Offset | integer | no |  |
| Limit | integer | no |  |
| Filters | array | no |  |

### Describe Group Info
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-group-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| GroupList | array | yes |  |

### Describe Group Offsets
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-group-offsets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| Group | string | yes |  |
| Topics | array | no |  |
| SearchWord | string | no |  |
| Offset | integer | no |  |
| Limit | integer | no |  |

### Describe Instance Attributes
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-instance-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |

### Describe Instances
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | no |  |
| SearchWord | string | no |  |
| Status | array | no |  |
| Offset | integer | no |  |
| Limit | integer | no |  |
| VpcId | string | no |  |

### Describe Instances Detail
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-instances-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | no |  |
| SearchWord | string | no |  |
| Status | array | no |  |
| Offset | integer | no |  |
| Limit | integer | no |  |
| TagKey | string | no |  |
| Filters | array | no |  |
| InstanceIdList | array | no |  |
| TagList | array | no |  |

### Describe Modify Type
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-modify-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| BandWidth | integer | yes |  |
| DiskSize | integer | yes |  |
| DiskType | string | yes |  |
| Partition | integer | yes |  |
| Topic | integer | yes |  |
| Type | string | yes |  |
| ModifyEntry | string | no |  |
| ModifyZone | boolean | no |  |

### Describe Prometheus
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-prometheus` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |

### Describe Region
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-region` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| Offset | integer | no |  |
| Limit | integer | no |  |
| Business | string | no |  |
| CdcId | string | no |  |

### Describe Route
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-route` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| RouteId | integer | no |  |
| MainRouteFlag | boolean | no |  |

### Describe Security Group Routes
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-security-group-routes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceRoute | object | no |  |
| Filters | array | no |  |
| Offset | integer | no |  |
| Limit | integer | no |  |
| SearchWord | string | no |  |

### Describe Task Status
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-task-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| FlowId | integer | yes |  |

### Describe Throttle Rules
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-throttle-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| SearchWord | string | no |  |
| Limit | integer | no |  |
| Offset | integer | no |  |
| ThrottleDimension | integer | no |  |

### Describe Topic
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-topic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| SearchWord | string | no |  |
| Offset | integer | no |  |
| Limit | integer | no |  |
| AclRuleName | string | no |  |

### Describe Topic Attributes
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-topic-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| TopicName | string | yes |  |

### Describe Topic Detail
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-topic-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| SearchWord | string | no |  |
| Offset | integer | no |  |
| Limit | integer | no |  |
| AclRuleName | string | no |  |
| OrderBy | string | no |  |
| OrderType | integer | no |  |
| Filters | array | no |  |
| SearchWordIgnoreCaseFlag | boolean | no |  |

### Describe Topic Flow Ranking
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-topic-flow-ranking` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| RankingType | string | yes |  |
| BeginDate | string | no |  |
| EndDate | string | no |  |
| BrokerIp | string | no |  |

### Describe Topic Produce Connection
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-topic-produce-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| TopicName | string | yes |  |

### Describe Topic Subscribe Group
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-topic-subscribe-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| TopicName | string | yes |  |
| Offset | integer | no |  |
| Limit | integer | no |  |

### Describe Topic Sync Replica
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-topic-sync-replica` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| TopicName | string | yes |  |
| Offset | integer | no |  |
| Limit | integer | no |  |
| OutOfSyncReplicaOnly | boolean | no |  |

### Describe Type Instances
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-type-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | no |  |
| SearchWord | string | no |  |
| Status | array | no |  |
| Offset | integer | no |  |
| Limit | integer | no |  |
| TagKey | string | no |  |

### Describe User
`POST https://apizie.tech/v1/cloud:tencent-ckafka/describe-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| SearchWord | string | no |  |
| Offset | integer | no |  |
| Limit | integer | no |  |

### Disassociate Routes Security Group
`POST https://apizie.tech/v1/cloud:tencent-ckafka/disassociate-routes-security-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceRoutes | array | yes |  |
| SecurityGroupId | string | yes |  |

### Fetch Datahub Message By Offset
`POST https://apizie.tech/v1/cloud:tencent-ckafka/fetch-datahub-message-by-offset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| Name | string | yes |  |
| Partition | integer | yes |  |
| Offset | integer | yes |  |

### Fetch Latest Datahub Message List
`POST https://apizie.tech/v1/cloud:tencent-ckafka/fetch-latest-datahub-message-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| Name | string | yes |  |
| Partition | integer | yes |  |
| Offset | integer | no |  |
| MessageCount | integer | no |  |

### Fetch Message By Offset
`POST https://apizie.tech/v1/cloud:tencent-ckafka/fetch-message-by-offset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| Topic | string | yes |  |
| Partition | integer | yes |  |
| Offset | integer | yes |  |

### Fetch Message List By Offset
`POST https://apizie.tech/v1/cloud:tencent-ckafka/fetch-message-list-by-offset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| Topic | string | yes |  |
| Partition | integer | yes |  |
| Offset | integer | yes |  |
| SinglePartitionRecordNumber | integer | no |  |

### Fetch Message List By Timestamp
`POST https://apizie.tech/v1/cloud:tencent-ckafka/fetch-message-list-by-timestamp` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| Topic | string | yes |  |
| Partition | integer | no |  |
| StartTime | integer | no |  |
| SinglePartitionRecordNumber | integer | no |  |

### Inquire Ckafka Price
`POST https://apizie.tech/v1/cloud:tencent-ckafka/inquire-ckafka-price` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceType | string | yes |  |
| InstanceChargeParam | object | no |  |
| InstanceNum | integer | no |  |
| Bandwidth | integer | no |  |
| InquiryDiskParam | object | no |  |
| MessageRetention | integer | no |  |
| Topic | integer | no |  |
| Partition | integer | no |  |
| ZoneIds | array | no |  |
| CategoryAction | string | no |  |
| BillType | string | no |  |
| PublicNetworkParam | object | no |  |
| InstanceId | string | no |  |

### Instance Scaling Down
`POST https://apizie.tech/v1/cloud:tencent-ckafka/instance-scaling-down` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| UpgradeStrategy | integer | yes |  |
| DiskSize | integer | no |  |
| BandWidth | integer | no |  |
| Partition | integer | no |  |

### Isolated Instance Pre
`POST https://apizie.tech/v1/cloud:tencent-ckafka/isolated-instance-pre` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |

### Modify Access Policy
`POST https://apizie.tech/v1/cloud:tencent-ckafka/modify-access-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| RouteId | integer | yes |  |
| IpWhitelist | array | no |  |

### Modify Acl Rule
`POST https://apizie.tech/v1/cloud:tencent-ckafka/modify-acl-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| RuleName | string | yes |  |
| IsApplied | integer | no |  |

### Modify Connect Resource
`POST https://apizie.tech/v1/cloud:tencent-ckafka/modify-connect-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ResourceId | string | yes |  |
| ResourceName | string | no |  |
| Description | string | no |  |
| Type | string | no |  |
| DtsConnectParam | object | no |  |
| MongoDBConnectParam | object | no |  |
| EsConnectParam | object | no |  |
| ClickHouseConnectParam | object | no |  |
| MySQLConnectParam | object | no |  |
| PostgreSQLConnectParam | object | no |  |
| MariaDBConnectParam | object | no |  |
| SQLServerConnectParam | object | no |  |
| CtsdbConnectParam | object | no |  |
| DorisConnectParam | object | no |  |
| KafkaConnectParam | object | no |  |
| MqttConnectParam | object | no |  |
| IcebergConnectParam | object | no |  |

### Modify Datahub Task
`POST https://apizie.tech/v1/cloud:tencent-ckafka/modify-datahub-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| TaskId | string | yes |  |
| TaskName | string | no |  |
| Description | string | no |  |
| TasksMax | integer | no |  |
| SyncThrottleLimit | integer | no |  |
| AutoExpandFlag | boolean | no |  |

### Modify Datahub Topic
`POST https://apizie.tech/v1/cloud:tencent-ckafka/modify-datahub-topic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| Name | string | yes |  |
| RetentionMs | integer | yes |  |
| Note | string | no |  |
| Tags | array | no |  |

### Modify Group Offsets
`POST https://apizie.tech/v1/cloud:tencent-ckafka/modify-group-offsets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| Group | string | yes |  |
| Strategy | integer | yes |  |
| Topics | array | yes |  |
| Shift | integer | no |  |
| ShiftTimestamp | integer | no |  |
| Offset | integer | no |  |
| Partitions | array | no |  |

### Modify Instance Attributes
`POST https://apizie.tech/v1/cloud:tencent-ckafka/modify-instance-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| MsgRetentionTime | integer | no |  |
| InstanceName | string | no |  |
| Config | object | no |  |
| DynamicRetentionConfig | object | no |  |
| RebalanceTime | integer | no |  |
| PublicNetwork | integer | no |  |
| MaxMessageByte | integer | no |  |
| UncleanLeaderElectionEnable | integer | no |  |
| DeleteProtectionEnable | integer | no |  |
| RetentionBytes | integer | no |  |
| AdminSecurity | boolean | no |  |
| TransactionalIdExpirationMs | integer | no |  |

### Modify Instance Pre
`POST https://apizie.tech/v1/cloud:tencent-ckafka/modify-instance-pre` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| DiskSize | integer | no |  |
| BandWidth | integer | no |  |
| Partition | integer | no |  |

### Modify Password
`POST https://apizie.tech/v1/cloud:tencent-ckafka/modify-password` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| Name | string | yes |  |
| Password | string | yes |  |
| PasswordNew | string | yes |  |

### Modify Route Security Groups
`POST https://apizie.tech/v1/cloud:tencent-ckafka/modify-route-security-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceRoute | object | yes |  |
| SecurityGroupIds | array | no |  |

### Modify Routine Maintenance Task
`POST https://apizie.tech/v1/cloud:tencent-ckafka/modify-routine-maintenance-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| MaintenanceType | string | yes |  |
| MaintenanceSubtype | string | yes |  |
| TopicName | string | no |  |
| ConfigureThreshold | integer | no |  |
| ConfigureStepSize | integer | no |  |
| ConfigureLimit | integer | no |  |
| PlannedTime | integer | no |  |
| ExtraConfig | string | no |  |
| Status | integer | no |  |
| Week | string | no |  |

### Modify Throttle Rule
`POST https://apizie.tech/v1/cloud:tencent-ckafka/modify-throttle-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ThrottleRuleId | integer | yes |  |
| InstanceId | string | yes |  |
| ConsumeThrottle | integer | no |  |

### Modify Topic Attributes
`POST https://apizie.tech/v1/cloud:tencent-ckafka/modify-topic-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| TopicName | string | yes |  |
| Note | string | no |  |
| EnableWhiteList | integer | no |  |
| MinInsyncReplicas | integer | no |  |
| UncleanLeaderElectionEnable | integer | no |  |
| RetentionMs | integer | no |  |
| MaxMessageBytes | integer | no |  |
| SegmentMs | integer | no |  |
| CleanUpPolicy | string | no |  |
| IpWhiteList | array | no |  |
| EnableAclRule | integer | no |  |
| AclRuleName | string | no |  |
| RetentionBytes | integer | no |  |
| Tags | array | no |  |
| QuotaProducerByteRate | integer | no |  |
| QuotaConsumerByteRate | integer | no |  |
| ReplicaNum | integer | no |  |
| LogMsgTimestampType | string | no |  |

### Pause Datahub Task
`POST https://apizie.tech/v1/cloud:tencent-ckafka/pause-datahub-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| TaskId | string | yes |  |

### Renew Ckafka Instance
`POST https://apizie.tech/v1/cloud:tencent-ckafka/renew-ckafka-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| TimeSpan | integer | no |  |

### Restart Datahub Task
`POST https://apizie.tech/v1/cloud:tencent-ckafka/restart-datahub-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| TaskId | string | yes |  |

### Resume Datahub Task
`POST https://apizie.tech/v1/cloud:tencent-ckafka/resume-datahub-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| TaskId | string | yes |  |

### Send Message
`POST https://apizie.tech/v1/cloud:tencent-ckafka/send-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| DataHubId | string | yes |  |
| Message | array | yes |  |

### Upgrade Broker Version
`POST https://apizie.tech/v1/cloud:tencent-ckafka/upgrade-broker-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| Type | integer | yes |  |
| SourceVersion | string | yes |  |
| TargetVersion | string | yes |  |
| DelayTimeStamp | string | no |  |

## Example
```
curl "https://apizie.tech/v1/cloud:tencent-ckafka/associate-routes-security-group" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Tencent Cloud Message Queue CKafka API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:tencent-ckafka/associate-routes-security-group with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Tencent Cloud Message Queue CKafka API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Tencent Cloud Message Queue CKafka itself also needs your own key from tencentcloudapi.com.

### Can AI agents use the Tencent Cloud Message Queue CKafka API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:tencent-ckafka.

### What is the status of the Tencent Cloud Message Queue CKafka API?
Needs your own provider key (bring your own key)