ACL object entity
Used by actions: DescribeACL.
| Name | Type | Description |
|---|---|---|
| ResourceType | Integer | ACL resource type. 0: UNKNOWN, 1: ANY, 2: TOPIC, 3: GROUP, 4: CLUSTER, 5: TRANSACTIONAL_ID. Currently, only TOPIC is available, |
| ResourceName | String | Resource name, which is related to resourceType. For example, if resourceType is TOPIC, this field indicates the topic name; if resourceType is GROUP, this field indicates the group name |
| Principal | String | User list. The default value is User:*, which means that any user can access. The current user can only be one included in the user listNote: this field may return null, indicating that no valid values can be obtained. |
| Host | String | The default value is *, which means that any host can access. Currently, CKafka does not support the host as *, but the future product based on the open-source Kafka will directly support thisNote: this field may return null, indicating that no valid values can be obtained. |
| Operation | Integer | ACL operation mode. 0: UNKNOWN, 1: ANY, 2: ALL, 3: READ, 4: WRITE, 5: CREATE, 6: DELETE, 7: ALTER, 8: DESCRIBE, 9: CLUSTER_ACTION, 10: DESCRIBE_CONFIGS, 11: ALTER_CONFIGS, 12: IDEMPOTEN_WRITE |
| PermissionType | Integer | Permission type. 0: UNKNOWN, 1: ANY, 2: DENY, 3: ALLOW |
Set of returned ACL results
Used by actions: DescribeACL.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of eligible data entries |
| AclList | Array of Acl | ACL list Note: this field may return null, indicating that no valid values can be obtained. |
AppId query result
Used by actions: DescribeAppInfo.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of eligible AppId |
| AppIdList | Array of Integer | List of eligible AppIdNote: this field may return null, indicating that no valid values can be obtained. |
Stores the information of partition assigned to this consumer
Used by actions: DescribeGroupInfo.
| Name | Type | Description |
|---|---|---|
| Version | Integer | Assignment version information |
| Topics | Array of GroupInfoTopics | Topic information list Note: this field may return null, indicating that no valid values can be obtained. |
Advanced configuration object
Used by actions: DescribeTopicAttributes, DescribeTopicDetail.
| Name | Type | Description |
|---|---|---|
| Retention | Integer | Message retention period Note: this field may return null, indicating that no valid values can be obtained. |
| MinInsyncReplicas | Integer | Minimum number of sync replications Note: this field may return null, indicating that no valid values can be obtained. |
| CleanUpPolicy | String | Log cleanup mode. Default value: delete. 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: this field may return null, indicating that no valid values can be obtained. |
| SegmentMs | Integer | Segment rolling duration Note: this field may return null, indicating that no valid values can be obtained. |
| UncleanLeaderElectionEnable | Integer | 0: false, 1: true. Note: this field may return null, indicating that no valid values can be obtained. |
| SegmentBytes | Integer | Number of bytes for segment rolling Note: this field may return null, indicating that no valid values can be obtained. |
| MaxMessageBytes | Integer | Maximum number of message bytes Note: this field may return null, indicating that no valid values can be obtained. |
User group entity
Used by actions: DescribeConsumerGroup.
| Name | Type | Description |
|---|---|---|
| ConsumerGroupName | String | User group name |
| SubscribedInfo | Array of SubscribedInfo | Subscribed message entity |
Returned consumer group result entity
Used by actions: DescribeConsumerGroup.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of eligible consumer groups |
| TopicList | Array of ConsumerGroupTopic | Topic list Note: this field may return null, indicating that no valid values can be obtained. |
| GroupList | Array of ConsumerGroup | Consumer group list Note: this field may return null, indicating that no valid values can be obtained. |
| TotalPartition | Integer | Total number of partitions Note: this field may return null, indicating that no valid values can be obtained. |
| PartitionListForMonitor | Array of Partition | List of monitored partitions Note: this field may return null, indicating that no valid values can be obtained. |
| TotalTopic | Integer | Total number of topics Note: this field may return null, indicating that no valid values can be obtained. |
| TopicListForMonitor | Array of ConsumerGroupTopic | List of monitored topics Note: this field may return null, indicating that no valid values can be obtained. |
| GroupListForMonitor | Array of Group | List of monitored groups Note: this field may return null, indicating that no valid values can be obtained. |
Consumer group topic object
Used by actions: DescribeConsumerGroup.
| Name | Type | Description |
|---|---|---|
| TopicId | String | Topic ID |
| TopicName | String | Topic name |
Return for topic creation
Used by actions: CreateTopic.
| Name | Type | Description |
|---|---|---|
| TopicId | String | Topic ID |
DescribeGroup response entity
Used by actions: DescribeGroup.
| Name | Type | Description |
|---|---|---|
| Group | String | groupId |
| Protocol | String | Protocol used by the group. |
Query filter
Key-value pair filters for conditional filtering queries, such as filter ID, name, and status
- If there are multiple
Filter, the relationship among them is logicalAND.- If there are multiple
Valuesin the sameFilter, the relationship among them is logicalOR.
Used by actions: DescribeInstancesDetail.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Field to be filtered. |
| Values | Array of String | Yes | Filter value of field. |
Group entity
Used by actions: DescribeConsumerGroup.
| Name | Type | Description |
|---|---|---|
| GroupName | String | Group name |
Consumer information
Used by actions: DescribeGroupInfo.
| Name | Type | Description |
|---|---|---|
| MemberId | String | Unique ID generated for consumer in consumer group by coordinator |
| ClientId | String | client.id information by the client consumer SDK |
| ClientHost | String | Generally stores client IP address |
| Assignment | Assignment | Stores the information of partition assigned to this consumer |
GroupInfo response data entity
Used by actions: DescribeGroupInfo.
| Name | Type | Description |
|---|---|---|
| ErrorCode | String | Error code. 0: success |
| State | String | Group status description (common valid values: Empty, Stable, Dead): Dead: the consumer group does not exist Empty: there are currently no consumer subscriptions in the consumer group PreparingRebalance: the consumer group is currently in rebalance stateCompletingRebalance: the consumer group is currently in rebalance stateStable: each consumer in the consumer group has joined and is in stable state |
| ProtocolType | String | The type of protocol selected by the consumer group, which is consumer for common consumers. However, some systems use their own protocols; for example, the protocol used by kafka-connect is connect. Only with the standard consumer protocol can this API get to know the specific assigning method and parse the specific partition assignment |
| Protocol | String | Consumer partition assignment algorithm, such as range (which is the default value for the Kafka consumer SDK), roundrobin, and sticky |
| Members | Array of GroupInfoMember | This array contains information only if state is Stable and protocol_type is consumer |
| Group | String | Kafka consumer group |
Internal topic object of GroupInfo
Used by actions: DescribeGroupInfo.
| Name | Type | Description |
|---|---|---|
| Topic | String | Name of assigned topics |
| Partitions | Array of Integer | Information of assigned partition Note: this field may return null, indicating that no valid values can be obtained. |
Group offset partition object
Used by actions: DescribeGroupOffsets.
| Name | Type | Description |
|---|---|---|
| Partition | Integer | Topic partitionId |
| Offset | Integer | Offset position submitted by consumer |
| Metadata | String | Metadata can be passed in for other purposes when the consumer submits messages. Currently, this parameter is usually an empty string Note: this field may return null, indicating that no valid values can be obtained. |
| ErrorCode | Integer | Error code |
| LogEndOffset | Integer | Latest offset of current partition |
| Lag | Integer | Number of unconsumed messages |
Returned result of consumer group offset
Used by actions: DescribeGroupOffsets.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of eligible results |
| TopicList | Array of GroupOffsetTopic | Array of partitions in the topic, where each element is a JSON object Note: this field may return null, indicating that no valid values can be obtained. |
Consumer group topic object
Used by actions: DescribeGroupOffsets.
| Name | Type | Description |
|---|---|---|
| Topic | String | Topic name |
| Partitions | Array of GroupOffsetPartition | Array of partitions in the topic, where each element is a JSON object Note: this field may return null, indicating that no valid values can be obtained. |
DescribeGroup response
Used by actions: DescribeGroup.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Count Note: this field may return null, indicating that no valid values can be obtained. |
| GroupList | Array of DescribeGroup | GroupList Note: this field may return null, indicating that no valid values can be obtained. |
Instance object
Used by actions: DescribeInstances.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID |
| InstanceName | String | Instance name |
| Status | Integer | Instance status. 0: creating, 1: running, 2: deleting, 5: isolated, -1: creation failed |
| IfCommunity | Boolean | Whether it is an open-source instance. true: yes, false: no Note: this field may return null, indicating that no valid values can be obtained. |
Returned result object of instance attributes
Used by actions: DescribeInstanceAttributes.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID |
| InstanceName | String | Instance name |
| VipList | Array of VipEntity | VIP list information of access point |
| Vip | String | Virtual IP |
| Vport | String | Virtual port |
| Status | Integer | Instance status. 0: creating, 1: running, 2: deleting |
| Bandwidth | Integer | Instance bandwidth in Mbps |
| DiskSize | Integer | Instance storage capacity in GB |
| ZoneId | Integer | AZ |
| VpcId | String | VPC ID. If this parameter is empty, it means the basic network |
| SubnetId | String | Subnet ID. If this parameter is empty, it means the basic network |
| Healthy | Integer | Instance health status. 1: healthy, 2: alarmed, 3: exceptional |
| HealthyMessage | String | Instance health information. Currently, the disk utilization is displayed with a maximum length of 256 |
| CreateTime | Integer | Creation time |
| MsgRetentionTime | Integer | Message retention period in minutes |
| Config | InstanceConfigDO | Configuration for automatic topic creation. If this field is empty, it means that automatic creation is not enabled |
| RemainderPartitions | Integer | Number of remaining creatable partitions |
| RemainderTopics | Integer | Number of remaining creatable topics |
| CreatedPartitions | Integer | Number of partitions already created |
| CreatedTopics | Integer | Number of topics already created |
| Tags | Array of Tag | Tag array Note: this field may return null, indicating that no valid values can be obtained. |
| ExpireTime | Integer | Expiration time Note: this field may return null, indicating that no valid values can be obtained. |
| ZoneIds | Array of Integer | Cross-AZ Note: this field may return null, indicating that no valid values can be obtained. |
| Version | String | Kafka version information Note: this field may return null, indicating that no valid values can be obtained. |
| MaxGroupNum | Integer | Maximum number of groups Note: this field may return null, indicating that no valid values can be obtained. |
| Cvm | Integer | Sale type Note: this field may return null, indicating that no valid values can be obtained. |
Instance configuration entity
Used by actions: DescribeInstanceAttributes.
| Name | Type | Description |
|---|---|---|
| AutoCreateTopicsEnable | Boolean | Whether to create topics automatically |
| DefaultNumPartitions | Integer | Number of partitions |
| DefaultReplicationFactor | Integer | Default replication factor |
Instance details
Used by actions: DescribeInstancesDetail.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID |
| InstanceName | String | Instance name |
| Vip | String | Instance VIP information |
| Vport | String | Instance port information |
| VipList | Array of VipEntity | Virtual IP list |
| Status | Integer | Instance status. 0: creating, 1: running, 2: deleting, 5: isolated, -1: creation failed |
| Bandwidth | Integer | Instance bandwidth in Mbps |
| DiskSize | Integer | Instance storage capacity in GB |
| ZoneId | Integer | AZ ID |
| VpcId | String | vpcId. If this parameter is empty, it means the basic network |
| SubnetId | String | Subnet ID |
| RenewFlag | Integer | Whether to renew the instance automatically, which is an int-type enumerated value. 1: yes, 2: no |
| Healthy | Integer | Instance status, which is an int-type value. 0: healthy, 1: alarmed, 2: exceptional |
| HealthyMessage | String | Instance status information |
| CreateTime | Integer | Instance creation time |
| ExpireTime | Integer | Instance expiration time |
| IsInternal | Integer | Whether it is an internal customer. 1: yes |
| TopicNum | Integer | Number of topics |
| Tags | Array of Tag | Tag |
| Version | String | Kafka version information Note: this field may return null, indicating that no valid values can be obtained. |
| ZoneIds | Array of Integer | Cross-AZ Note: this field may return null, indicating that no valid values can be obtained. |
| Cvm | Integer | CKafka sale type Note: this field may return null, indicating that no valid values can be obtained. |
Returned result of instance details
Used by actions: DescribeInstancesDetail.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of eligible instances |
| InstanceList | Array of InstanceDetail | List of eligible instance details |
Aggregated returned result of instance status
Used by actions: DescribeInstances.
| Name | Type | Description |
|---|---|---|
| InstanceList | Array of Instance | List of eligible instances Note: this field may return null, indicating that no valid values can be obtained. |
| TotalCount | Integer | Total number of eligible results Note: this field may return null, indicating that no valid values can be obtained. |
Returned result value of operation
Used by actions: CreateAcl, CreatePartition, CreateTopicIpWhiteList, CreateUser, DeleteAcl, DeleteTopic, DeleteTopicIpWhiteList, DeleteUser, ModifyGroupOffsets, ModifyInstanceAttributes, ModifyPassword, ModifyTopicAttributes.
| Name | Type | Description |
|---|---|---|
| ReturnCode | String | Returned code. 0: normal, other values: error |
| ReturnMessage | String | Success message |
| Data | OperateResponseData | Data returned by an operation, which may contain flowId, etc.Note: this field may return null, indicating that no valid values can be obtained. |
Configuration object for modifying instance attributes
Used by actions: ModifyInstanceAttributes.
| Name | Type | Required | Description |
|---|---|---|---|
| AutoCreateTopicEnable | Boolean | No | Automatic creation. true: enabled, false: not enabled |
| DefaultNumPartitions | Integer | No | Optional. If auto.create.topic.enable is set to true and this value is not set, 3 will be used by default |
| DefaultReplicationFactor | Integer | No | If auto.create.topic.enable is set to true but this value is not set, 2 will be used by default |
Data structure returned by operation
Used by actions: CreateAcl, CreatePartition, CreateTopicIpWhiteList, CreateUser, DeleteAcl, DeleteTopic, DeleteTopicIpWhiteList, DeleteUser, ModifyGroupOffsets, ModifyInstanceAttributes, ModifyPassword, ModifyTopicAttributes.
| Name | Type | Description |
|---|---|---|
| FlowId | Integer | FlowId Note: this field may return null, indicating that no valid values can be obtained. |
Partition entity
Used by actions: DescribeConsumerGroup.
| Name | Type | Description |
|---|---|---|
| PartitionId | Integer | Partition ID |
Partition and offset
Used by actions: DescribeConsumerGroup.
| Name | Type | Description |
|---|---|---|
| Partition | String | Partition, such as "0" or "1" Note: this field may return null, indicating that no valid values can be obtained. |
| Offset | Integer | Offset, such as 100 Note: this field may return null, indicating that no valid values can be obtained. |
Route entity object
Used by actions: DescribeRoute.
| Name | Type | Description |
|---|---|---|
| AccessType | Integer | Instance connection method 0: PLAINTEXT (plaintext method, which does not carry user information and is supported for legacy versions and Community Edition) 1: SASL_PLAINTEXT (plaintext method, which authenticates the login through SASL before data start and is supported only for Community Edition) 2: SSL (SSL-encrypted communication, which does not carry user information and is supported for legacy versions and Community Edition) 3: SASL_SSL (SSL-encrypted communication, which authenticates the login through SASL before data start and is supported only for Community Edition) |
| RouteId | Integer | Route ID |
| VipType | Integer | VIP network type (1: public network TGW; 2: classic network; 3: VPC; 4: Tencent Cloud-supported environment (generally used for internal instances); 5: SSL public network access; 6: BM VPC) |
| VipList | Array of VipEntity | Virtual IP list |
| Domain | String | Domain name Note: this field may return null, indicating that no valid values can be obtained. |
| DomainPort | Integer | Domain name port Note: this field may return null, indicating that no valid values can be obtained. |
Returned object for route information
Used by actions: DescribeRoute.
| Name | Type | Description |
|---|---|---|
| Routers | Array of Route | Route information list Note: this field may return null, indicating that no valid values can be obtained. |
Subscribed message entity
Used by actions: DescribeConsumerGroup.
| Name | Type | Description |
|---|---|---|
| TopicName | String | Subscribed topic name |
| Partition | Array of Integer | Subscribed partition Note: this field may return null, indicating that no valid values can be obtained. |
| PartitionOffset | Array of PartitionOffset | Partition offset information Note: this field may return null, indicating that no valid values can be obtained. |
Tag object in instance details
Used by actions: DescribeInstanceAttributes, DescribeInstancesDetail.
| Name | Type | Description |
|---|---|---|
| TagKey | String | Tag key |
| TagValue | String | Tag value |
Returned topic object
Used by actions: DescribeTopic.
| Name | Type | Description |
|---|---|---|
| TopicId | String | Topic ID |
| TopicName | String | Topic name |
| Note | String | Remarks Note: this field may return null, indicating that no valid values can be obtained. |
Returned topic attributes result entity
Used by actions: DescribeTopicAttributes.
| Name | Type | Description |
|---|---|---|
| TopicId | String | Topic ID |
| CreateTime | Integer | Creation time |
| Note | String | Topic remarks Note: this field may return null, indicating that no valid values can be obtained. |
| PartitionNum | Integer | Number of partitions |
| EnableWhiteList | Integer | IP allowlist switch. 1: enabled, 0: disabled |
| IpWhiteList | Array of String | IP allowlist list |
| Config | Config | Topic configuration array |
| Partitions | Array of TopicPartitionDO | Partition details |
Topic details
Used by actions: DescribeTopicDetail.
| Name | Type | Description |
|---|---|---|
| TopicName | String | Topic name |
| TopicId | String | Topic ID |
| PartitionNum | Integer | Number of partitions |
| ReplicaNum | Integer | Number of replicas |
| Note | String | Remarks Note: this field may return null, indicating that no valid values can be obtained. |
| CreateTime | Integer | Creation time |
| EnableWhiteList | Boolean | Whether to enable IP authentication allowlist. true: yes, false: no |
| IpWhiteListCount | Integer | Number of IPs in IP allowlist |
| ForwardCosBucket | String | COS bucket for data backup: address of the destination COS bucket Note: this field may return null, indicating that no valid values can be obtained. |
| ForwardStatus | Integer | Status of data backup to COS. 1: not enabled, 0: enabled |
| ForwardInterval | Integer | Frequency of data backup to COS |
| Config | Config | Advanced configuration Note: this field may return null, indicating that no valid values can be obtained. |
Returned topic details entity
Used by actions: DescribeTopicDetail.
| Name | Type | Description |
|---|---|---|
| TopicList | Array of TopicDetail | List of returned topic details Note: this field may return null, indicating that no valid values can be obtained. |
| TotalCount | Integer | Number of all eligible topic details |
Partition details
Used by actions: DescribeTopicAttributes.
| Name | Type | Description |
|---|---|---|
| Partition | Integer | Partition ID |
| LeaderStatus | Integer | Leader running status |
| IsrNum | Integer | ISR quantity |
| ReplicaNum | Integer | Number of replicas |
TopicResponse returned uniformly
Used by actions: DescribeTopic.
| Name | Type | Description |
|---|---|---|
| TopicList | Array of Topic | List of returned topic information Note: this field may return null, indicating that no valid values can be obtained. |
| TotalCount | Integer | Number of eligible topics Note: this field may return null, indicating that no valid values can be obtained. |
User entity
Used by actions: DescribeUser.
| Name | Type | Description |
|---|---|---|
| UserId | Integer | User ID |
| Name | String | Username |
| CreateTime | Timestamp | Creation time |
| UpdateTime | Timestamp | Last updated time |
Returned user entity
Used by actions: DescribeUser.
| Name | Type | Description |
|---|---|---|
| Users | Array of User | List of eligible users Note: this field may return null, indicating that no valid values can be obtained. |
| TotalCount | Integer | Total number of eligible users |
Virtual IP entity
Used by actions: DescribeInstanceAttributes, DescribeInstancesDetail, DescribeRoute.
| Name | Type | Description |
|---|---|---|
| Vip | String | Virtual IP |
| Vport | String | Virtual port |
Was this page helpful?