租户端 互联网中间件 消息队列（CKafka） 数据结构

数据结构

最近更新时间: 2022-05-10 11:14:35

TopicPartitionDO

分区详情

被如下接口引用：DescribeTopicAttributes

名称 类型 描述
Partition Long Partition ID
LeaderStatus Long Leader 运行状态
IsrNum Long ISR 个数
ReplicaNum Long 副本个数

PartitionOffset

分区和位移

被如下接口引用：DescribeConsumerGroup

名称 类型 描述
Partition String Partition,例如"0"或"1"
Offset Long Offset,例如100

DescribeBrokersResponses

DescribeBrokersResponses

被如下接口引用：DescribeBrokers

名称 类型 描述
TotalCount Long 总数
Brokers Array of DescribeBrokerResponse Brokers

DescribeGroup

DescribeGroup返回实体

被如下接口引用：DescribeGroup

名称 类型 描述
Group String groupId
Protocol String 该 group 使用的协议。

Error

返回的错误信息

被如下接口引用：

名称 类型 描述
Code String 错误码
Message String 错误信息

Acl

ACL对象实体

被如下接口引用：DescribeACL

名称 类型 描述
ResourceType Long Acl资源类型，（0:UNKNOWN，1:ANY，2:TOPIC，3:GROUP，4:CLUSTER，5:TRANSACTIONAL_ID）当前只有TOPIC，
ResourceName String 资源名称，和resourceType相关如当resourceType为TOPIC时，则该字段表示topic名称，当resourceType为GROUP时，该字段表示group名称
Principal String 用户列表，默认为User:*，表示任何user都可以访问，当前用户只能是用户列表中包含的用户
Host String 默认为，表示任何host都可以访问，当前ckafka不支持host为，但是后面开源kafka的产品化会直接支持
Operation Long Acl操作方式(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 Long 权限类型(0:UNKNOWN，1:ANY，2:DENY，3:ALLOW)

CreateTopicResp

创建主题返回

被如下接口引用：CreateTopic

名称 类型 描述
TopicId String 主题Id

InstanceDetail

实例详情

被如下接口引用：DescribeInstanceDetail、DescribeInstancesDetail

名称 类型 描述
InstanceId String 实例id
InstanceName String 实例名称
Vip String 访问实例的vip 信息
Vport String 访问实例的端口信息
VipList Array of VipEntity 虚拟IP列表
Status Long 实例的状态。0：创建中，1：运行中，2：删除中：5隔离中， -1 创建失败
Bandwidth Long 实例带宽，单位Mbps
DiskSize Long 实例的存储大小，单位GB
ZoneId Long 可用区域ID
VpcId String vpcId，如果为空，说明是基础网络
SubnetId String 子网id
RenewFlag Long 实例是否续费，int 枚举值：1表示自动续费，2表示明确不自动续费
Healthy Long 实例状态 int：0表示健康，1表示告警，2 表示实例状态异常
HealthyMessage String 实例状态信息
CreateTime Long 实例创建时间时间
ExpireTime Long 实例过期时间
IsInternal Long 是否为内部客户。值为1 表示内部客户
TopicNum Long Topic个数
Tags Array of Tag 标识tag
Version String kafka版本信息
ZoneIds Array of Long 跨可用区
Cvm Long ckafka售卖类型
CpuArch Long 集群的 CPU 架构。1:x86; 2:arm; 按位标记架构类型，例：3 二进制为 0011，表示 x86、arm 混合架构

SoldOut

售罄标志

被如下接口引用：

名称 类型 描述
Cvm String false未售罄

DescribeClustersResponses

DescribeClustersResponses

被如下接口引用：

名称 类型 描述
Brokers Array of DescribeClustersResponse 集群信息
TotalCount Long 总数

SubscribedInfo

订阅信息实体

被如下接口引用：DescribeConsumerGroup

名称 类型 描述
TopicName String 订阅的主题名
Partition Array of Long 订阅的分区
PartitionOffset Array of PartitionOffset 分区offset信息

Group

组实体

被如下接口引用：DescribeConsumerGroup

名称 类型 描述
GroupName String 组名称

Assignment

存储着分配给该消费者的 partition 信息

被如下接口引用：DescribeGroupInfo

名称 类型 描述
Version Long assingment版本信息
Topics Array of GroupInfoTopics topic信息列表

Instance

实例对象

被如下接口引用：DescribeInstances

名称 类型 描述
InstanceId String 实例id
InstanceName String 实例名称
Status Long 实例的状态。0：创建中，1：运行中，2：删除中 ， 5 隔离中，-1 创建失败
IfCommunity Boolean 是否开源实例。开源：true，不开源：false

ConsumerGroup

用户组实体

被如下接口引用：DescribeConsumerGroup

名称 类型 描述
ConsumerGroupName String 用户组名称
SubscribedInfo Array of SubscribedInfo 订阅信息实体

User

用户实体

被如下接口引用：DescribeUser

名称 类型 描述
UserId Long 用户id
Name String 用户名称
CreateTime String 创建时间
UpdateTime String 最后更新时间

Tag

实例详情中的标签对象

被如下接口引用：DescribeInstanceAttributes、DescribeInstanceDetail、DescribeInstancesDetail

名称 类型 描述
TagKey String 标签的key
TagValue String 标签的值

Partition

分区实体

被如下接口引用：DescribeConsumerGroup

名称 类型 描述
PartitionId Long 分区ID

PriceObject

价格对象

被如下接口引用：DescribeCkafkaPrice

名称 类型 描述
Pid String pid
Price Long 价格
Value Long 值
PriceModel String 价格模式
PriceDetail Array of PriceDetail 价格详情数组
TotalCost Long 总消费
BillingItemCode String 账单代码
SubBillingItemCode String 子账单代码
RealTotalCost Float 实际总花费
Policy Float 方案
PolicyDetail PolicyDetail 方案详情

InstanceTypeConfigDO

实例规格配置对象

被如下接口引用：DescribeCkafkaTypeConfigs

名称 类型 描述
Type String 型号
Desc String 类型描述
Bandwidth Long 带宽流量大小，单位Mbqs
DiskSize Long 磁盘大小，单位GB
Pid Long 类型对应的pid信息
MaximumInstancePartition Long 该规格可以创建的分区数量配额
MaximumInstanceTopic Long 该规格可以创建的主题数量配额

InstanceConfigDO

实例配置实体

被如下接口引用：DescribeInstanceAttributes

名称 类型 描述
AutoCreateTopicsEnable Boolean 是否自动创建主题
DefaultNumPartitions Long 分区数
DefaultReplicationFactor Long 默认的复制Factor

GroupInfoTopics

GroupInfo内部topic对象

被如下接口引用：DescribeGroupInfo

名称 类型 描述
Topic String 分配的 topic 名称
Partitions Array of Long 分配的 partition 信息

ConnectorStatus

获取数据同步任务状态返回对象

被如下接口引用：DescribeConnectorStatus

名称 类型 描述
State String connector 状态。UNASSIGNED：任务还未分配；RUNNING：connector 正在运行；PAUSED：connector 已经暂停；FAILED：任务失败；DESTROYED：任务销毁。
Type String connector 类型，有 source 和 sink 两种类型。

Region

地域实体对象

被如下接口引用：

名称 类型 描述
RegionId Long 地域ID
RegionName String 地域名称
AreaName String 区域名称
RegionCode String 地域代码
RegionCodeV3 String 地域代码（V3版本）
Support String NONE:默认值不支持任何特殊机型\nCVM:支持CVM类型

TopicResult

统一返回的TopicResponse

被如下接口引用：DescribeTopic

名称 类型 描述
TopicList Array of Topic 返回的主题信息列表
TotalCount Long 符合条件的 topic 数量

Connector

连接器实例

被如下接口引用：DescribeConnector

名称 类型 描述
ConnectorId String connectorId。
Name String connector 名称。
Type String connector 类型。 source：导入数据到 Kafka；sink：将数据从 Kafka 导出。
ConnectorClass String 执行该任务的 class 名称。
SourceRegion String 源所在地域。
Source String 源地址。
SinkRegion String 目的所在地域。
Sink String 目的地址。
Status String connector 当前状态。 该状态展示有一定的延迟，任务状态可通过 GetConnectorStatus 接口 获取。 UNASSIGNED：任务还未分配；RUNNING：connector 正在运行；PAUSED：connector 已经暂停；FAILED：任务失败；DESTROYED：任务销毁。
Description String connector 描述信息。
CreateTime String 创建时间。
UpdateTime String 修改时间。

GroupInfoMember

consumer信息

被如下接口引用：DescribeGroupInfo

名称 类型 描述
MemberId String coordinator 为消费分组中的消费者生成的唯一 ID
ClientId String 客户消费者 SDK 自己设置的 client.id 信息
ClientHost String 一般存储客户的 IP 地址
Assignment Assignment 存储着分配给该消费者的 partition 信息

Route

路由实体对象

被如下接口引用：DescribeRoute

名称 类型 描述
AccessType Long 实例接入方式0：PLAINTEXT (明文方式，没有带用户信息老版本及社区版本都支持)1：SASL_PLAINTEXT（明文方式，不过在数据开始时，会通过SASL方式登录鉴权，仅社区版本支持）2：SSL（SSL加密通信，没有带用户信息，老版本及社区版本都支持）3：SASL_SSL（SSL加密通信，在数据开始时，会通过SASL方式登录鉴权，仅社区版本支持）
RouteId Long 路由ID
VipType Long vip网络类型（1:外网TGW 2:基础网络 3:VPC网络 4:腾讯云支持环境(一般用于内部实例) 5:SSL外网访问方式访问 6:黑石环境vpc）
VipList Array of VipEntity 虚拟IP列表
Domain String 域名
DomainPort Long 域名port

DescribeClustersController

DescribeClustersController

被如下接口引用：

名称 类型 描述
Id Long id
Ip String ip
Epoch Long epoch

Filter

查询过滤器

描述键值对过滤器，用于条件过滤查询。例如过滤ID、名称、状态等

  • 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。
  • 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。

被如下接口引用：DescribeInstanceDetail、DescribeInstancesDetail

名称 类型 描述
Name String 需要过滤的字段。
Values Array of String 字段的过滤值。

GroupOffsetPartition

组偏移量分区对象

被如下接口引用：DescribeGroupOffsets

名称 类型 描述
Partition Long topic 的 partitionId
Offset Long consumer 提交的 offset 位置
Metadata String 支持消费者提交消息时，传入 metadata 作为它用，当前一般为空字符串
ErrorCode Long 错误码
LogEndOffset Long 当前 partition 最新的 offset
Lag Long 未消费的消息个数

GroupOffsetTopic

消费分组主题对象

被如下接口引用：DescribeGroupOffsets

名称 类型 描述
Topic String 主题名称
Partitions Array of GroupOffsetPartition 该主题分区数组，其中每个元素为一个 json object

VipEntity

虚拟IP实体

被如下接口引用：DescribeInstanceAttributes、DescribeInstanceDetail、DescribeInstancesDetail、DescribeRoute

名称 类型 描述
Vip String 虚拟IP
Vport String 虚拟端口

OperateResponseData

操作类型返回的Data结构

被如下接口引用：CreateAcl、CreateConnector、CreatePartition、CreateRoute、CreateTopicIpWhiteList、CreateUser、DeleteAcl、DeleteConnector、DeleteRoute、DeleteTopic、DeleteTopicIpWhiteList、DeleteUser、ModifyGroupOffsets、ModifyInstanceAttributes、ModifyPassword、ModifyResourceTce、ModifyTopicAttributes、PauseConnector、ResumeConnector

名称 类型 描述
FlowId Long FlowId

TopicDetail

主题详情

被如下接口引用：DescribeTopicDetail

名称 类型 描述
TopicName String 主题名称
TopicId String 主题ID
PartitionNum Long 分区数
ReplicaNum Long 副本数
Note String 备注
CreateTime Long 创建时间
EnableWhiteList Boolean 是否开启ip鉴权白名单，true表示开启，false表示不开启
IpWhiteListCount Long ip白名单中ip个数
ForwardCosBucket String 数据备份cos bucket: 转存到cos 的bucket地址
ForwardStatus Long 数据备份cos 状态： 1 不开启数据备份，0 开启数据备份
ForwardInterval Long 数据备份到cos的周期频率
Config Config 高级配置

Topic

返回的topic对象

被如下接口引用：DescribeTopic

名称 类型 描述
TopicId String 主题的ID
TopicName String 主题的名称
Note String 备注

CreateInstancePreData

创建预付费接口返回的Data

被如下接口引用：

名称 类型 描述
FlowId Long CreateInstancePre返回固定为0，不能作为CheckTaskStatus的查询条件。只是为了保证和后台数据结构对齐。
DealNames Array of String 订单号列表

PriceDetail

价格详情

被如下接口引用：DescribeCkafkaPrice

名称 类型 描述
SinglePrice Long 单价
UsedAmount Long 使用数量
Cost Long 花费

Price

消息价格实体

被如下接口引用：DescribeCkafkaZone

名称 类型 描述
RealTotalCost Float 折扣价
TotalCost Float 原价

PolicyDetail

折扣详情

被如下接口引用：DescribeCkafkaPrice

名称 类型 描述
Total Float 总折扣
User Float 用户个人折扣
Common Long 官网基础折扣
Activity Long Activity
DiscountType String 折扣类型
DiscountId Long 折扣ID
PreferentialType Long 优惠类型
DiscountSpecifiedPid Long 指定折扣pid
Combine Float Combine

ZoneInfo

zone信息实体

被如下接口引用：DescribeCkafkaZone

名称 类型 描述
ZoneId String zone的id
IsInternalApp Long 是否内部APP
AppId Long app id
Flag Boolean 标识
ZoneName String zone名称
ZoneStatus Long zone状态
Exflag String 额外标识
SoldOut String json对象，key为机型，value true为售罄，false为未售罄

ModifyInstanceAttributesConfig

修改实例属性的配置对象

被如下接口引用：ModifyInstanceAttributes

名称 类型 描述
AutoCreateTopicEnable Boolean 自动创建 true 表示开启，false 表示不开启
DefaultNumPartitions Long 可选，如果auto.create.topic.enable设置为true没有设置该值时，默认设置为3
DefaultReplicationFactor Long 如歌auto.create.topic.enable设置为true没有指定该值时默认设置为2

PartDetail

价格对象详情

被如下接口引用：DescribeCkafkaPrice

名称 类型 描述
Disk PriceObject 硬盘价格
CloudKafka PriceObject ckafka价格

ConsumerGroupTopic

消费组主题对象

被如下接口引用：DescribeConsumerGroup

名称 类型 描述
TopicId String 主题ID
TopicName String 主题名称

Config

高级配置对象

被如下接口引用：DescribeTopicAttributes、DescribeTopicDetail

名称 类型 描述
Retention Long 消息保留时间
MinInsyncReplicas Long 最小同步复制数
CleanUpPolicy String 日志清理模式，默认 delete。delete：日志按保存时间删除；compact：日志按 key 压缩；compact, delete：日志按 key 压缩且会保存时间删除。
SegmentMs Long Segment 分片滚动的时长
UncleanLeaderElectionEnable Long 0表示 false。 1表示 true。
SegmentBytes Long Segment 分片滚动的字节数
MaxMessageBytes Long 最大消息字节数

ClusterInfo

集群信息实体

被如下接口引用：DescribeCkafkaZone

名称 类型 描述
ClusterId Long 集群Id
ClusterName String 集群名称
ZoneId Long 集群可用区
ZoneIds Array of Long Broker 的可用区列表
CpuArch Long 集群的 CPU 架构。1:x86; 2:arm; 按位标记架构类型，例：3 二进制为 0011，表示 x86、arm 混合架构
MaxDiskSize Long 集群最大磁盘 单位GB
MaxBandWidth Long 集群最大带宽 单位MB/s
AvailableDiskSize Long 集群当前可用磁盘 单位GB
AvailableBandWidth Long 集群当前可用带宽 单位MB/s