数据结构

最近更新时间:2020-03-25 08:19:13

Acl

ACL对象实体

被如下接口引用:DescribeACL。

名称 类型 描述
ResourceType Integer 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都可以访问,当前用户只能是用户列表中包含的用户
注意:此字段可能返回 null,表示取不到有效值。
Host String 默认为,表示任何host都可以访问,当前ckafka不支持host为,但是后面开源kafka的产品化会直接支持
注意:此字段可能返回 null,表示取不到有效值。
Operation Integer 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 Integer 权限类型(0:UNKNOWN,1:ANY,2:DENY,3:ALLOW)

AclResponse

ACL返回结果集

被如下接口引用:DescribeACL。

名称 类型 描述
TotalCount Integer 符合条件的总数据条数
AclList Array of Acl ACL列表
注意:此字段可能返回 null,表示取不到有效值。

AppIdResponse

AppId的查询结果

被如下接口引用:DescribeAppInfo。

名称 类型 描述
TotalCount Integer 符合要求的所有AppId数量
AppIdList Array of Integer 符合要求的App Id列表
注意:此字段可能返回 null,表示取不到有效值。

Assignment

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

被如下接口引用:DescribeGroupInfo。

名称 类型 描述
Version Integer assingment版本信息
Topics Array of GroupInfoTopics topic信息列表
注意:此字段可能返回 null,表示取不到有效值。

Config

高级配置对象

被如下接口引用:DescribeTopicAttributes、DescribeTopicDetail。

名称 类型 描述
Retention Integer 消息保留时间
注意:此字段可能返回 null,表示取不到有效值。
MinInsyncReplicas Integer 最小同步复制数
注意:此字段可能返回 null,表示取不到有效值。
CleanUpPolicy String 日志清理模式,默认 delete。
delete:日志按保存时间删除;compact:日志按 key 压缩;compact, delete:日志按 key 压缩且会保存时间删除。
注意:此字段可能返回 null,表示取不到有效值。
SegmentMs Integer Segment 分片滚动的时长
注意:此字段可能返回 null,表示取不到有效值。
UncleanLeaderElectionEnable Integer 0表示 false。 1表示 true。
注意:此字段可能返回 null,表示取不到有效值。
SegmentBytes Integer Segment 分片滚动的字节数
注意:此字段可能返回 null,表示取不到有效值。
MaxMessageBytes Integer 最大消息字节数
注意:此字段可能返回 null,表示取不到有效值。

ConsumerGroup

用户组实体

被如下接口引用:DescribeConsumerGroup。

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

ConsumerGroupResponse

消费组返回结果实体

被如下接口引用:DescribeConsumerGroup。

名称 类型 描述
TotalCount Integer 符合条件的消费组数量
TopicList Array of ConsumerGroupTopic 主题列表
注意:此字段可能返回 null,表示取不到有效值。
GroupList Array of ConsumerGroup 消费分组List
注意:此字段可能返回 null,表示取不到有效值。
TotalPartition Integer 所有分区数量
注意:此字段可能返回 null,表示取不到有效值。
PartitionListForMonitor Array of Partition 监控的分区列表
注意:此字段可能返回 null,表示取不到有效值。
TotalTopic Integer 主题总数
注意:此字段可能返回 null,表示取不到有效值。
TopicListForMonitor Array of ConsumerGroupTopic 监控的主题列表
注意:此字段可能返回 null,表示取不到有效值。
GroupListForMonitor Array of Group 监控的组列表
注意:此字段可能返回 null,表示取不到有效值。

ConsumerGroupTopic

消费组主题对象

被如下接口引用:DescribeConsumerGroup。

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

CreateTopicResp

创建主题返回

被如下接口引用:CreateTopic。

名称 类型 描述
TopicId String 主题Id

DescribeGroup

DescribeGroup返回实体

被如下接口引用:DescribeGroup。

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

Filter

查询过滤器

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

  • 若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。
  • 若同一个Filter存在多个Values,同一FilterValues间的关系为逻辑或(OR)关系。

被如下接口引用:DescribeInstancesDetail。

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

Group

组实体

被如下接口引用:DescribeConsumerGroup。

名称 类型 描述
GroupName String 组名称

GroupInfoMember

consumer信息

被如下接口引用:DescribeGroupInfo。

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

GroupInfoResponse

GroupInfo返回数据的实体

被如下接口引用:DescribeGroupInfo。

名称 类型 描述
ErrorCode String 错误码,正常为0
State String group 状态描述(常见的为 Empty、Stable、Dead 三种状态):
Dead:消费分组不存在
Empty:消费分组,当前没有任何消费者订阅
PreparingRebalance:消费分组处于 rebalance 状态
CompletingRebalance:消费分组处于 rebalance 状态
Stable:消费分组中各个消费者已经加入,处于稳定状态
ProtocolType String 消费分组选择的协议类型正常的消费者一般为 consumer 但有些系统采用了自己的协议如 kafka-connect 用的就是 connect。只有标准的 consumer 协议,本接口才知道具体的分配方式的格式,才能解析到具体的 partition 的分配情况
Protocol String 消费者 partition 分配算法常见的有如下几种(Kafka 消费者 SDK 默认的选择项为 range):range、 roundrobin、 sticky
Members Array of GroupInfoMember 仅当 state 为 Stable 且 protocol_type 为 consumer 时, 该数组才包含信息
Group String Kafka 消费分组

GroupInfoTopics

GroupInfo内部topic对象

被如下接口引用:DescribeGroupInfo。

名称 类型 描述
Topic String 分配的 topic 名称
Partitions Array of Integer 分配的 partition 信息
注意:此字段可能返回 null,表示取不到有效值。

GroupOffsetPartition

组偏移量分区对象

被如下接口引用:DescribeGroupOffsets。

名称 类型 描述
Partition Integer topic 的 partitionId
Offset Integer consumer 提交的 offset 位置
Metadata String 支持消费者提交消息时,传入 metadata 作为它用,当前一般为空字符串
注意:此字段可能返回 null,表示取不到有效值。
ErrorCode Integer 错误码
LogEndOffset Integer 当前 partition 最新的 offset
Lag Integer 未消费的消息个数

GroupOffsetResponse

消费组偏移量返回结果

被如下接口引用:DescribeGroupOffsets。

名称 类型 描述
TotalCount Integer 符合调节的总结果数
TopicList Array of GroupOffsetTopic 该主题分区数组,其中每个元素为一个 json object
注意:此字段可能返回 null,表示取不到有效值。

GroupOffsetTopic

消费分组主题对象

被如下接口引用:DescribeGroupOffsets。

名称 类型 描述
Topic String 主题名称
Partitions Array of GroupOffsetPartition 该主题分区数组,其中每个元素为一个 json object
注意:此字段可能返回 null,表示取不到有效值。

GroupResponse

DescribeGroup的返回

被如下接口引用:DescribeGroup。

名称 类型 描述
TotalCount Integer 计数
注意:此字段可能返回 null,表示取不到有效值。
GroupList Array of DescribeGroup GroupList
注意:此字段可能返回 null,表示取不到有效值。

Instance

实例对象

被如下接口引用:DescribeInstances。

名称 类型 描述
InstanceId String 实例id
InstanceName String 实例名称
Status Integer 实例的状态。0:创建中,1:运行中,2:删除中 , 5 隔离中,-1 创建失败
IfCommunity Boolean 是否开源实例。开源:true,不开源:false
注意:此字段可能返回 null,表示取不到有效值。

InstanceAttributesResponse

实例属性返回结果对象

被如下接口引用:DescribeInstanceAttributes。

名称 类型 描述
InstanceId String 实例ID
InstanceName String 实例名称
VipList Array of VipEntity 接入点 VIP 列表信息
Vip String 虚拟IP
Vport String 虚拟端口
Status Integer 实例的状态。0:创建中,1:运行中,2:删除中
Bandwidth Integer 实例带宽,单位:Mbps
DiskSize Integer 实例的存储大小,单位:GB
ZoneId Integer 可用区
VpcId String VPC 的 ID,为空表示是基础网络
SubnetId String 子网 ID, 为空表示基础网络
Healthy Integer 实例健康状态, 1:健康,2:告警,3:异常
HealthyMessage String 实例健康信息,当前会展示磁盘利用率,最大长度为256
CreateTime Integer 创建时间
MsgRetentionTime Integer 消息保存时间,单位为分钟
Config InstanceConfigDO 自动创建 Topic 配置, 若该字段为空,则表示未开启自动创建
RemainderPartitions Integer 剩余创建分区数
RemainderTopics Integer 剩余创建主题数
CreatedPartitions Integer 当前创建分区数
CreatedTopics Integer 当前创建主题数
Tags Array of Tag 标签数组
注意:此字段可能返回 null,表示取不到有效值。
ExpireTime Integer 过期时间
注意:此字段可能返回 null,表示取不到有效值。
ZoneIds Array of Integer 跨可用区
注意:此字段可能返回 null,表示取不到有效值。
Version String kafka版本信息
注意:此字段可能返回 null,表示取不到有效值。
MaxGroupNum Integer 最大分组数
注意:此字段可能返回 null,表示取不到有效值。
Cvm Integer 售卖类型
注意:此字段可能返回 null,表示取不到有效值。

InstanceConfigDO

实例配置实体

被如下接口引用:DescribeInstanceAttributes。

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

InstanceDetail

实例详情

被如下接口引用:DescribeInstancesDetail。

名称 类型 描述
InstanceId String 实例id
InstanceName String 实例名称
Vip String 访问实例的vip 信息
Vport String 访问实例的端口信息
VipList Array of VipEntity 虚拟IP列表
Status Integer 实例的状态。0:创建中,1:运行中,2:删除中:5隔离中, -1 创建失败
Bandwidth Integer 实例带宽,单位Mbps
DiskSize Integer 实例的存储大小,单位GB
ZoneId Integer 可用区域ID
VpcId String vpcId,如果为空,说明是基础网络
SubnetId String 子网id
RenewFlag Integer 实例是否续费,int 枚举值:1表示自动续费,2表示明确不自动续费
Healthy Integer 实例状态 int:0表示健康,1表示告警,2 表示实例状态异常
HealthyMessage String 实例状态信息
CreateTime Integer 实例创建时间时间
ExpireTime Integer 实例过期时间
IsInternal Integer 是否为内部客户。值为1 表示内部客户
TopicNum Integer Topic个数
Tags Array of Tag 标识tag
Version String kafka版本信息
注意:此字段可能返回 null,表示取不到有效值。
ZoneIds Array of Integer 跨可用区
注意:此字段可能返回 null,表示取不到有效值。
Cvm Integer ckafka售卖类型
注意:此字段可能返回 null,表示取不到有效值。

InstanceDetailResponse

实例详情返回结果

被如下接口引用:DescribeInstancesDetail。

名称 类型 描述
TotalCount Integer 符合条件的实例总数
InstanceList Array of InstanceDetail 符合条件的实例详情列表

InstanceResponse

聚合的实例状态返回结果

被如下接口引用:DescribeInstances。

名称 类型 描述
InstanceList Array of Instance 符合条件的实例列表
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 符合条件的结果总数
注意:此字段可能返回 null,表示取不到有效值。

JgwOperateResponse

操作型结果返回值

被如下接口引用:CreateAcl、CreatePartition、CreateTopicIpWhiteList、CreateUser、DeleteAcl、DeleteTopic、DeleteTopicIpWhiteList、DeleteUser、ModifyGroupOffsets、ModifyInstanceAttributes、ModifyPassword、ModifyTopicAttributes。

名称 类型 描述
ReturnCode String 返回的code,0为正常,非0为错误
ReturnMessage String 成功消息
Data OperateResponseData 操作型返回的Data数据,可能有flowId等
注意:此字段可能返回 null,表示取不到有效值。

ModifyInstanceAttributesConfig

修改实例属性的配置对象

被如下接口引用:ModifyInstanceAttributes。

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

OperateResponseData

操作类型返回的Data结构

被如下接口引用:CreateAcl、CreatePartition、CreateTopicIpWhiteList、CreateUser、DeleteAcl、DeleteTopic、DeleteTopicIpWhiteList、DeleteUser、ModifyGroupOffsets、ModifyInstanceAttributes、ModifyPassword、ModifyTopicAttributes。

名称 类型 描述
FlowId Integer FlowId
注意:此字段可能返回 null,表示取不到有效值。

Partition

分区实体

被如下接口引用:DescribeConsumerGroup。

名称 类型 描述
PartitionId Integer 分区ID

PartitionOffset

分区和位移

被如下接口引用:DescribeConsumerGroup。

名称 类型 描述
Partition String Partition,例如"0"或"1"
注意:此字段可能返回 null,表示取不到有效值。
Offset Integer Offset,例如100
注意:此字段可能返回 null,表示取不到有效值。

SubscribedInfo

订阅信息实体

被如下接口引用:DescribeConsumerGroup。

名称 类型 描述
TopicName String 订阅的主题名
Partition Array of Integer 订阅的分区
注意:此字段可能返回 null,表示取不到有效值。
PartitionOffset Array of PartitionOffset 分区offset信息
注意:此字段可能返回 null,表示取不到有效值。

Tag

实例详情中的标签对象

被如下接口引用:DescribeInstanceAttributes、DescribeInstancesDetail。

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

Topic

返回的topic对象

被如下接口引用:DescribeTopic。

名称 类型 描述
TopicId String 主题的ID
TopicName String 主题的名称
Note String 备注
注意:此字段可能返回 null,表示取不到有效值。

TopicAttributesResponse

主题属性返回结果实体

被如下接口引用:DescribeTopicAttributes。

名称 类型 描述
TopicId String 主题 ID
CreateTime Integer 创建时间
Note String 主题备注
注意:此字段可能返回 null,表示取不到有效值。
PartitionNum Integer 分区个数
EnableWhiteList Integer IP 白名单开关,1:打开; 0:关闭
IpWhiteList Array of String IP 白名单列表
Config Config topic 配置数组
Partitions Array of TopicPartitionDO 分区详情

TopicDetail

主题详情

被如下接口引用:DescribeTopicDetail。

名称 类型 描述
TopicName String 主题名称
TopicId String 主题ID
PartitionNum Integer 分区数
ReplicaNum Integer 副本数
Note String 备注
注意:此字段可能返回 null,表示取不到有效值。
CreateTime Integer 创建时间
EnableWhiteList Boolean 是否开启ip鉴权白名单,true表示开启,false表示不开启
IpWhiteListCount Integer ip白名单中ip个数
ForwardCosBucket String 数据备份cos bucket: 转存到cos 的bucket地址
注意:此字段可能返回 null,表示取不到有效值。
ForwardStatus Integer 数据备份cos 状态: 1 不开启数据备份,0 开启数据备份
ForwardInterval Integer 数据备份到cos的周期频率
Config Config 高级配置
注意:此字段可能返回 null,表示取不到有效值。

TopicDetailResponse

主题详情返回实体

被如下接口引用:DescribeTopicDetail。

名称 类型 描述
TopicList Array of TopicDetail 返回的主题详情列表
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 符合条件的所有主题详情数量

TopicPartitionDO

分区详情

被如下接口引用:DescribeTopicAttributes。

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

TopicResult

统一返回的TopicResponse

被如下接口引用:DescribeTopic。

名称 类型 描述
TopicList Array of Topic 返回的主题信息列表
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 符合条件的 topic 数量
注意:此字段可能返回 null,表示取不到有效值。

User

用户实体

被如下接口引用:DescribeUser。

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

UserResponse

用户返回实体

被如下接口引用:DescribeUser。

名称 类型 描述
Users Array of User 符合条件的用户列表
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 符合条件的总用户数

VipEntity

虚拟IP实体

被如下接口引用:DescribeInstanceAttributes、DescribeInstancesDetail。

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