消息队列 CKafka

动态与公告

产品简介

购买指南

快速入门

消息平台操作指南

DataHub 操作指南

最佳实践

故障处理

API 文档

SDK 文档

通用参考

常见问题

服务等级协议

联系我们

词汇表
文档中心 > 消息队列 CKafka > API 文档 > 数据结构

数据结构

最近更新时间：2022-07-05 06:09:26

我的收藏

本页目录：

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，表示取不到有效值。

AclRule

AclRule列表接口出参

被如下接口引用：DescribeTopicAttributes。

名称 类型 描述
RuleName String Acl规则名称
注意：此字段可能返回 null，表示取不到有效值。
InstanceId String 实例ID
注意：此字段可能返回 null，表示取不到有效值。
PatternType String 匹配类型，目前只支持前缀匹配，枚举值列表：PREFIXED
注意：此字段可能返回 null，表示取不到有效值。
Pattern String 表示前缀匹配的前缀的值
注意：此字段可能返回 null，表示取不到有效值。
ResourceType String Acl资源类型,目前只支持Topic,枚举值列表：Topic
注意：此字段可能返回 null，表示取不到有效值。
AclList String 该规则所包含的ACL信息
注意：此字段可能返回 null，表示取不到有效值。
CreateTimeStamp String 规则所创建的时间
注意：此字段可能返回 null，表示取不到有效值。
IsApplied Integer 预设ACL规则是否应用到新增的topic中
注意：此字段可能返回 null，表示取不到有效值。
UpdateTimeStamp String 规则更新时间
注意：此字段可能返回 null，表示取不到有效值。
Comment String 规则的备注
注意：此字段可能返回 null，表示取不到有效值。
TopicName String 其中一个显示的对应的TopicName
注意：此字段可能返回 null，表示取不到有效值。
TopicCount Integer 应用该ACL规则的Topic数
注意：此字段可能返回 null，表示取不到有效值。
PatternTypeTitle String patternType的中文显示
注意：此字段可能返回 null，表示取不到有效值。

AclRuleInfo

表示ACL 规则的四元组信息

被如下接口引用：BatchCreateAcl。

名称 类型 必选 描述
Operation String 是 Acl操作方式，枚举值(所有操作: All, 读：Read，写：Write)
PermissionType String 是 权限类型，(Deny，Allow)
Host String 是 默认为，表示任何host都可以访问，当前ckafka不支持host为和ip网段
Principal String 是 用户列表，默认为User:*，表示任何user都可以访问，当前用户只能是用户列表中包含的用户。传入格式需要带【User:】前缀。例如用户A，传入为User:A。

AppIdResponse

AppId的查询结果

被如下接口引用：DescribeAppInfo。

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

Assignment

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

被如下接口引用：DescribeGroupInfo, DescribeTopicSubscribeGroup。

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

BatchContent

批量发送消息内容

被如下接口引用：SendMessage。

名称 类型 必选 描述
Body String 是 发送的消息体
Key String 否 发送消息的键名

BatchModifyTopicInfo

批量修改topic参数

被如下接口引用：BatchModifyTopicAttributes。

名称 类型 必选 描述
TopicName String 是 topic名称
PartitionNum Integer 否 分区数
Note String 否 备注
ReplicaNum Integer 否 副本数
CleanUpPolicy String 否 消息删除策略，可以选择delete 或者compact
MinInsyncReplicas Integer 否 当producer设置request.required.acks为-1时，min.insync.replicas指定replicas的最小数目
UncleanLeaderElectionEnable Boolean 否 是否允许非ISR的副本成为Leader
RetentionMs Integer 否 topic维度的消息保留时间（毫秒）范围1 分钟到90 天
RetentionBytes Integer 否 topic维度的消息保留大小，范围1 MB到1024 GB
SegmentMs Integer 否 Segment分片滚动的时长（毫秒），范围1 到90 天
MaxMessageBytes Integer 否 批次的消息大小，范围1 KB到12 MB

BatchModifyTopicResultDTO

批量修改topic属性结果

被如下接口引用：BatchModifyTopicAttributes。

名称 类型 描述
InstanceId String 实例id
注意：此字段可能返回 null，表示取不到有效值。
TopicName String topic名称
注意：此字段可能返回 null，表示取不到有效值。
ReturnCode String 状态码
注意：此字段可能返回 null，表示取不到有效值。
Message String 状态消息

ClusterInfo

集群信息实体

被如下接口引用：DescribeCkafkaZone。

名称 类型 描述
ClusterId Integer 集群Id
ClusterName String 集群名称
MaxDiskSize Integer 集群最大磁盘 单位GB
注意：此字段可能返回 null，表示取不到有效值。
MaxBandWidth Integer 集群最大带宽 单位MB/s
注意：此字段可能返回 null，表示取不到有效值。
AvailableDiskSize Integer 集群当前可用磁盘 单位GB
注意：此字段可能返回 null，表示取不到有效值。
AvailableBandWidth Integer 集群当前可用带宽 单位MB/s
注意：此字段可能返回 null，表示取不到有效值。
ZoneId Integer 集群所属可用区，表明集群归属的可用区
注意：此字段可能返回 null，表示取不到有效值。
ZoneIds Array of Integer 集群节点所在的可用区，若该集群为跨可用区集群，则包含该集群节点所在的多个可用区。
注意：此字段可能返回 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，表示取不到有效值。
RetentionBytes 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 主题名称

ConsumerRecord

消息记录

被如下接口引用：FetchMessageByOffset。

名称 类型 描述
Topic String 主题名
Partition Integer 分区id
Offset Integer 位点
Key String 消息key
注意：此字段可能返回 null，表示取不到有效值。
Value String 消息value
注意：此字段可能返回 null，表示取不到有效值。
Timestamp Integer 消息时间戳
注意：此字段可能返回 null，表示取不到有效值。

CreateInstancePreData

创建预付费接口返回的Data

被如下接口引用：CreateInstancePre, DeleteInstancePre, ModifyInstancePre。

名称 类型 描述
FlowId Integer CreateInstancePre返回固定为0，不能作为CheckTaskStatus的查询条件。只是为了保证和后台数据结构对齐。
注意：此字段可能返回 null，表示取不到有效值。
DealNames Array of String 订单号列表
注意：此字段可能返回 null，表示取不到有效值。
InstanceId String 实例Id
注意：此字段可能返回 null，表示取不到有效值。

CreateInstancePreResp

创建预付费实例返回结构

被如下接口引用：CreateInstancePre, DeleteInstancePre, ModifyInstancePre。

名称 类型 描述
ReturnCode String 返回的code，0为正常，非0为错误
ReturnMessage String 成功消息
Data CreateInstancePreData 操作型返回的Data数据
注意：此字段可能返回 null，表示取不到有效值。
DeleteRouteTimestamp String 删除是时间
注意：此字段可能返回 null，表示取不到有效值。

CreateTopicResp

创建主题返回

被如下接口引用：CreateTopic。

名称 类型 描述
TopicId String 主题Id

DescribeGroup

DescribeGroup返回实体

被如下接口引用：DescribeGroup。

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

DynamicDiskConfig

动态硬盘扩容配置

被如下接口引用：DescribeInstanceAttributes, ModifyInstanceAttributes。

名称 类型 必选 描述
Enable Integer 否 动态硬盘扩容配置开关（0: 关闭，1: 开启）
注意：此字段可能返回 null，表示取不到有效值。
StepForwardPercentage Integer 否 每次磁盘动态扩容大小百分比
注意：此字段可能返回 null，表示取不到有效值。
DiskQuotaPercentage Integer 否 磁盘配额百分比触发条件，即消息达到此值触发硬盘自动扩容事件
注意：此字段可能返回 null，表示取不到有效值。
MaxDiskSpace Integer 否 最大扩容硬盘大小，以 GB 为单位
注意：此字段可能返回 null，表示取不到有效值。

DynamicRetentionTime

动态消息保留时间配置

被如下接口引用：DescribeInstanceAttributes, ModifyInstanceAttributes。

名称 类型 必选 描述
Enable Integer 否 动态消息保留时间配置开关（0: 关闭，1: 开启）
注意：此字段可能返回 null，表示取不到有效值。
DiskQuotaPercentage Integer 否 磁盘配额百分比触发条件，即消息达到此值触发消息保留时间变更事件
注意：此字段可能返回 null，表示取不到有效值。
StepForwardPercentage Integer 否 每次向前调整消息保留时间百分比
注意：此字段可能返回 null，表示取不到有效值。
BottomRetention Integer 否 保底时长，单位分钟
注意：此字段可能返回 null，表示取不到有效值。

Filter

查询过滤器

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

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

被如下接口引用：DescribeInstancesDetail。

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

Group

组实体

被如下接口引用：DescribeConsumerGroup。

名称 类型 描述
GroupName String 组名称

GroupInfoMember

consumer信息

被如下接口引用：DescribeGroupInfo, DescribeTopicSubscribeGroup。

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

GroupInfoResponse

GroupInfo返回数据的实体

被如下接口引用：DescribeGroupInfo, DescribeTopicSubscribeGroup。

名称 类型 描述
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, DescribeTopicSubscribeGroup。

名称 类型 描述
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 售卖类型,0:标准版,1:专业版
注意：此字段可能返回 null，表示取不到有效值。
InstanceType String 类型
注意：此字段可能返回 null，表示取不到有效值。
Features Array of String 表示该实例支持的特性。FEATURE_SUBNET_ACL:表示acl策略支持设置子网。
注意：此字段可能返回 null，表示取不到有效值。
RetentionTimeConfig DynamicRetentionTime 动态消息保留策略
注意：此字段可能返回 null，表示取不到有效值。
MaxConnection Integer 最大连接数
注意：此字段可能返回 null，表示取不到有效值。
PublicNetwork Integer 公网带宽
注意：此字段可能返回 null，表示取不到有效值。
DeleteRouteTimestamp String 时间
注意：此字段可能返回 null，表示取不到有效值。
RemainingPartitions Integer 剩余创建分区数
注意：此字段可能返回 null，表示取不到有效值。
RemainingTopics Integer 剩余创建主题数
注意：此字段可能返回 null，表示取不到有效值。
DynamicDiskConfig DynamicDiskConfig 动态硬盘扩容策略
注意：此字段可能返回 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：1表示健康，2表示告警，3 表示实例状态异常
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，表示取不到有效值。
InstanceType String ckafka实例类型
注意：此字段可能返回 null，表示取不到有效值。
DiskType String 磁盘类型
注意：此字段可能返回 null，表示取不到有效值。
MaxTopicNumber Integer 当前规格最大Topic数
注意：此字段可能返回 null，表示取不到有效值。
MaxPartitionNumber Integer 当前规格最大Partition数
注意：此字段可能返回 null，表示取不到有效值。
RebalanceTime String 计划升级配置时间
注意：此字段可能返回 null，表示取不到有效值。
PartitionNumber Integer 实例当前partition数量
注意：此字段可能返回 null，表示取不到有效值。
PublicNetworkChargeType String 公网带宽类型
注意：此字段可能返回 null，表示取不到有效值。
PublicNetwork Integer 公网带宽值
注意：此字段可能返回 null，表示取不到有效值。
ClusterType String 实例类型
注意：此字段可能返回 null，表示取不到有效值。

InstanceDetailResponse

实例详情返回结果

被如下接口引用：DescribeInstancesDetail。

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

InstanceQuotaConfigResp

实例 / topic 维度限流策略

被如下接口引用：DescribeTopicAttributes。

名称 类型 描述
QuotaProducerByteRate Integer 生产限流大小，单位 MB/s
注意：此字段可能返回 null，表示取不到有效值。
QuotaConsumerByteRate Integer 消费限流大小，单位 MB/s
注意：此字段可能返回 null，表示取不到有效值。

InstanceResponse

聚合的实例状态返回结果

被如下接口引用：DescribeInstances。

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

JgwOperateResponse

操作型结果返回值

被如下接口引用：BatchModifyGroupOffsets, CreateAcl, CreateConsumer, CreatePartition, CreateRoute, CreateTopicIpWhiteList, CreateUser, DeleteAcl, DeleteGroup, DeleteRoute, 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结构

被如下接口引用：BatchModifyGroupOffsets, CreateAcl, CreateConsumer, CreatePartition, CreateRoute, CreateTopicIpWhiteList, CreateUser, DeleteAcl, DeleteGroup, DeleteRoute, DeleteTopic, DeleteTopicIpWhiteList, DeleteUser, ModifyGroupOffsets, ModifyInstanceAttributes, ModifyPassword, ModifyTopicAttributes。

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

Partition

分区实体

被如下接口引用：DescribeConsumerGroup。

名称 类型 描述
PartitionId Integer 分区ID

PartitionOffset

分区和位移

被如下接口引用：DescribeConsumerGroup。

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

Partitions

partition信息

被如下接口引用：BatchModifyGroupOffsets。

名称 类型 必选 描述
Partition Integer 是 分区
Offset Integer 是 partition 消费位移

Price

消息价格实体

被如下接口引用：DescribeCkafkaZone。

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

Region

地域实体对象

被如下接口引用：DescribeRegion。

名称 类型 描述
RegionId Integer 地域ID
RegionName String 地域名称
AreaName String 区域名称
RegionCode String 地域代码
注意：此字段可能返回 null，表示取不到有效值。
RegionCodeV3 String 地域代码（V3版本）
注意：此字段可能返回 null，表示取不到有效值。
Support String NONE:默认值不支持任何特殊机型\nCVM:支持CVM类型
注意：此字段可能返回 null，表示取不到有效值。
Ipv6 Integer 是否支持ipv6, 0：表示不支持，1：表示支持
注意：此字段可能返回 null，表示取不到有效值。
MultiZone Integer 是否支持跨可用区, 0：表示不支持，1：表示支持
注意：此字段可能返回 null，表示取不到有效值。

Route

路由实体对象

被如下接口引用：DescribeRoute。

名称 类型 描述
AccessType Integer 实例接入方式
0：PLAINTEXT (明文方式，没有带用户信息老版本及社区版本都支持)
1：SASL_PLAINTEXT（明文方式，不过在数据开始时，会通过SASL方式登录鉴权，仅社区版本支持）
2：SSL（SSL加密通信，没有带用户信息，老版本及社区版本都支持）
3：SASL_SSL（SSL加密通信，在数据开始时，会通过SASL方式登录鉴权，仅社区版本支持）
RouteId Integer 路由ID
VipType Integer vip网络类型（1:外网TGW 2:基础网络 3:VPC网络 4:支撑网络(idc 环境) 5:SSL外网访问方式访问 6:黑石环境vpc 7:支撑网络(cvm 环境）
VipList Array of VipEntity 虚拟IP列表
Domain String 域名
注意：此字段可能返回 null，表示取不到有效值。
DomainPort Integer 域名port
注意：此字段可能返回 null，表示取不到有效值。
DeleteTimestamp String 时间戳
注意：此字段可能返回 null，表示取不到有效值。

RouteResponse

路由信息返回对象

被如下接口引用：DescribeRoute。

名称 类型 描述
Routers Array of Route 路由信息列表
注意：此字段可能返回 null，表示取不到有效值。

SaleInfo

标准版销售信息

被如下接口引用：DescribeCkafkaZone。

名称 类型 描述
Flag Boolean 手动设置的flag标志
注意：此字段可能返回 null，表示取不到有效值。
Version String ckakfa版本号(1.1.1/2.4.2/0.10.2)
注意：此字段可能返回 null，表示取不到有效值。
Platform String 专业版、标准版标志
注意：此字段可能返回 null，表示取不到有效值。
SoldOut Boolean 售罄标志：true售罄
注意：此字段可能返回 null，表示取不到有效值。

SubscribedInfo

订阅信息实体

被如下接口引用：DescribeConsumerGroup。

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

Tag

实例详情中的标签对象

被如下接口引用：CreateInstancePre, CreateTopic, DescribeInstanceAttributes, DescribeInstancesDetail, ModifyTopicAttributes。

名称 类型 描述
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 分区详情
EnableAclRule Integer ACL预设策略开关，1：打开； 0：关闭
注意：此字段可能返回 null，表示取不到有效值。
AclRuleList Array of AclRule 预设策略列表
注意：此字段可能返回 null，表示取不到有效值。
QuotaConfig InstanceQuotaConfigResp topic 限流策略
注意：此字段可能返回 null，表示取不到有效值。

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，表示取不到有效值。
RetentionTimeConfig TopicRetentionTimeConfigRsp 消息保留时间配置(用于动态配置变更记录)
注意：此字段可能返回 null，表示取不到有效值。
Status Integer 0:正常，1：已删除，2：删除中
注意：此字段可能返回 null，表示取不到有效值。

TopicDetailResponse

主题详情返回实体

被如下接口引用：DescribeTopicDetail。

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

TopicInSyncReplicaInfo

topic副本及详细信息

被如下接口引用：DescribeTopicSyncReplica。

名称 类型 描述
Partition String 分区名称
Leader Integer Leader Id
Replica String 副本集
InSyncReplica String ISR
BeginOffset Integer 起始Offset
注意：此字段可能返回 null，表示取不到有效值。
EndOffset Integer 末端Offset
注意：此字段可能返回 null，表示取不到有效值。
MessageCount Integer 消息数
注意：此字段可能返回 null，表示取不到有效值。
OutOfSyncReplica String 未同步副本集
注意：此字段可能返回 null，表示取不到有效值。

TopicInSyncReplicaResult

Topic 副本及详情数据集合

被如下接口引用：DescribeTopicSyncReplica。

名称 类型 描述
TopicInSyncReplicaList Array of TopicInSyncReplicaInfo Topic详情及副本合集
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，表示取不到有效值。

TopicRetentionTimeConfigRsp

Topic消息保留时间配置返回信息

被如下接口引用：DescribeTopicDetail。

名称 类型 描述
Expect Integer 期望值，即用户配置的Topic消息保留时间(单位分钟)
注意：此字段可能返回 null，表示取不到有效值。
Current Integer 当前值，即当前生效值(可能存在动态调整，单位分钟)
注意：此字段可能返回 null，表示取不到有效值。
ModTimeStamp Integer 最近变更时间
注意：此字段可能返回 null，表示取不到有效值。

TopicSubscribeGroup

DescribeTopicSubscribeGroup接口出参

被如下接口引用：DescribeTopicSubscribeGroup。

名称 类型 描述
TotalCount Integer 总数
StatusCountInfo String 消费分组状态数量信息
GroupsInfo Array of GroupInfoResponse 消费分组信息
注意：此字段可能返回 null，表示取不到有效值。
Status Integer 此次请求是否异步的状态。实例里分组较少的会直接返回结果,Status为1。当分组较多时,会异步更新缓存，Status为0时不会返回分组信息，直至Status为1更新完毕返回结果。
注意：此字段可能返回 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, DescribeRoute。

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

ZoneInfo

zone信息实体

被如下接口引用：DescribeCkafkaZone。

名称 类型 描述
ZoneId String zone的id
IsInternalApp Integer 是否内部APP
AppId Integer app id
Flag Boolean 标识
ZoneName String zone名称
ZoneStatus Integer zone状态
Exflag String 额外标识
SoldOut String json对象，key为机型，value true为售罄，false为未售罄
SalesInfo Array of SaleInfo 标准版售罄信息
注意：此字段可能返回 null，表示取不到有效值。

ZoneResponse

查询kafka的zone信息返回的实体

被如下接口引用：DescribeCkafkaZone。

名称 类型 描述
ZoneList Array of ZoneInfo zone列表
MaxBuyInstanceNum Integer 最大购买实例个数
MaxBandwidth Integer 最大购买带宽 单位Mb/s
UnitPrice Price 后付费单位价格
MessagePrice Price 后付费消息单价
ClusterInfo Array of ClusterInfo 用户独占集群信息
注意：此字段可能返回 null，表示取不到有效值。
Standard String 购买标准版配置
注意：此字段可能返回 null，表示取不到有效值。
StandardS2 String 购买标准版S2配置
注意：此字段可能返回 null，表示取不到有效值。
Profession String 购买专业版配置
注意：此字段可能返回 null，表示取不到有效值。
Physical String 购买物理独占版配置
注意：此字段可能返回 null，表示取不到有效值。
PublicNetwork String 公网带宽
注意：此字段可能返回 null，表示取不到有效值。
PublicNetworkLimit String 公网带宽配置
注意：此字段可能返回 null，表示取不到有效值。
目录
中国站