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

数据结构

最近更新时间: 2026-07-13 00:08:51

DescribeBrokersResponses

DescribeBrokersResponses

被如下接口引用：DescribeBrokers

名称 必选 允许NULL 类型 描述
TotalCount 是 否 Int64 总数
示例值： 10
Brokers 是 否 Array of DescribeBrokerResponse Brokers
示例值：查看

InstanceConfigDO

实例配置实体

被如下接口引用：DescribeInstanceAttributes

名称 必选 允许NULL 类型 描述
AutoCreateTopicsEnable 是 否 Bool 是否自动创建主题
示例值： false
DefaultNumPartitions 是 否 Int64 分区数
示例值： 0
DefaultReplicationFactor 是 否 Int64 默认的复制Factor
示例值： 0

GroupOffsetPartition

组偏移量分区对象

被如下接口引用：DescribeGroupOffsets

名称 必选 允许NULL 类型 描述
Partition 是 否 Int64 topic 的 partitionId
示例值： 0
Offset 是 否 Int64 consumer 提交的 offset 位置
示例值： 0
Metadata 是 是 String 支持消费者提交消息时，传入 metadata 作为它用，当前一般为空字符串
示例值： Metadata-test
ErrorCode 是 否 Int64 错误码
示例值： 502
LogEndOffset 是 否 Int64 当前 partition 最新的 offset
示例值： 118
Lag 是 否 Int64 未消费的消息个数
示例值： 1

PolicyDetail

折扣详情

被如下接口引用：DescribeCkafkaPrice

名称 必选 允许NULL 类型 描述
Total 是 否 Float 总折扣
示例值： 100
User 是 否 Float 用户个人折扣
示例值： 100
Common 是 否 Int64 官网基础折扣
示例值： 100
Activity 是 否 Int64 Activity
示例值： 6783
DiscountType 是 是 String 折扣类型
示例值： 0
DiscountId 是 是 Int64 折扣ID
示例值： 167899
PreferentialType 是 是 Int64 优惠类型
示例值： 2
DiscountSpecifiedPid 是 是 Int64 指定折扣pid
示例值： 7869
Combine 是 是 Float Combine
示例值： 96.543208

ClusterInfo

集群信息实体

被如下接口引用：DescribeCkafkaZone

名称 必选 允许NULL 类型 描述
ClusterId 是 否 Int64 集群Id
示例值： 6894
ClusterName 是 否 String 集群名称
示例值： 100003-ckafka-test
ZoneId 否 否 Int64 集群可用区
示例值： 100003
ZoneIds 否 否 Array of Int64 Broker 的可用区列表
示例值： [100003,100002]
CpuArch 否 否 Int64 集群的 CPU 架构。1:x86; 2:arm; 按位标记架构类型，例：3 二进制为 0011，表示 x86、arm 混合架构
示例值： 1
MaxDiskSize 是 是 Int64 集群最大磁盘 单位GB
示例值： 198
MaxBandWidth 是 是 Int64 集群最大带宽 单位MB/s
示例值： 19
AvailableDiskSize 是 是 Int64 集群当前可用磁盘  单位GB
示例值： 198
AvailableBandWidth 是 是 Int64 集群当前可用带宽 单位MB/s
示例值： 19

GoodsInfo

后付费商品入参信息

被如下接口引用：HourCreate、HourModify

名称 必选 允许NULL 类型 描述
GoodsCategoryId 否 否 Int64 订单类型ID，接入计费时由计费后台分配
示例值： 1
RegionId 是 否 Int64 区域ID
示例值： 1
ZoneId 否 否 Int64 可用区ID，没有可用区概念则不传
示例值： 12121312
GoodsNum 是 否 Int64 新购时表示商品数量，续费与配置变更时固定传1
示例值： 1
ProjectId 否 否 Int64 项目ID，适用于公有云
示例值： 1
PlatformProjectId 否 否 String 项目ID，适用于专有云、私有云等非公有云平台
示例值： 1
PayMode 是 否 Int64 付费模式，0后付费/1预付费
示例值： 1
Platform 否 否 Int64 平台，0开放平台/1云平台 没有则不传
示例值： 1
GoodsDetail 是 否 String 商品详情，timeSpan表示购买时间长度，timeUnit表示购买时间单位，pid表示定价公式ID
示例值： []
Type 否 否 String 类型
示例值： 1

ModifyInstanceAttributesConfig

修改实例属性的配置对象

被如下接口引用：ModifyInstanceAttributes

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

OperateResponseData

操作类型返回的Data结构

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

名称 必选 允许NULL 类型 描述
FlowId 是 是 Int64 FlowId
示例值： 500201

PartitionOffset

分区和位移

被如下接口引用：DescribeConsumerGroup

名称 必选 允许NULL 类型 描述
Partition 是 是 String Partition,例如"0"或"1"
示例值： 0
Offset 是 是 Int64 Offset,例如100
示例值： 20

TopicResult

统一返回的TopicResponse

被如下接口引用：DescribeTopic

名称 必选 允许NULL 类型 描述
TopicList 是 是 Array of Topic 返回的主题信息列表
示例值：查看
TotalCount 是 是 Int64 符合条件的 topic 数量
示例值： 1

Partition

分区实体

被如下接口引用：DescribeConsumerGroup

名称 必选 允许NULL 类型 描述
PartitionId 是 否 Int64 分区ID
示例值： 0

TaskStatusResponse

任务状态返回对象

被如下接口引用：DescribeTaskStatus

名称 必选 允许NULL 类型 描述
Status 是 否 Int64 任务状态:
0 成功
1 失败
2 进行中
示例值： 1
Output 是 是 String 输出信息
示例值： 任务异常失败

PriceObject

价格对象

被如下接口引用：DescribeCkafkaPrice

名称 必选 允许NULL 类型 描述
Pid 是 否 String pid
示例值： 11413
Price 是 否 Int64 价格
示例值： 69900
Value 是 否 Int64 值
示例值： 1
PriceModel 是 否 String 价格模式
示例值： specified
PriceDetail 是 是 Array of PriceDetail 价格详情数组
示例值：查看
TotalCost 是 否 Int64 总消费
示例值： 69900
BillingItemCode 是 是 String 账单代码
示例值： v_ckafka_instance
SubBillingItemCode 是 是 String 子账单代码
示例值： sv_ckafka_instance_standard
RealTotalCost 是 是 Float 实际总花费
示例值： 69900
Policy 是 是 Float 方案
示例值： 100
PolicyDetail 是 是 PolicyDetail 方案详情
示例值：查看

Connector

连接器实例

被如下接口引用：DescribeConnector

名称 必选 允许NULL 类型 描述
ConnectorId 是 否 String connectorId。
示例值： connector-test
Name 是 否 String connector 名称。
示例值： resource-test
Type 是 否 String connector 类型。 source：导入数据到 Kafka；sink：将数据从 Kafka 导出。
示例值： KAFKA
ConnectorClass 是 否 String 执行该任务的 class 名称。
示例值： com.cloud.ckafka.replicator.K2KSourceConnector
SourceRegion 是 否 String 源所在地域。
示例值： [1]
Source 是 否 String 源地址。
示例值： source
SinkRegion 是 否 String 目的所在地域。
示例值： [0]
Sink 是 否 String 目的地址。
示例值： sink
Status 是 否 String connector 当前状态。 该状态展示有一定的延迟，任务状态可通过 GetConnectorStatus 接口 获取。 
UNASSIGNED：任务还未分配；RUNNING：connector 正在运行；PAUSED：connector 已经暂停；FAILED：任务失败；DESTROYED：任务销毁。
示例值： 1
Description 是 是 String connector 描述信息。
示例值： test
CreateTime 是 是 String 创建时间。
示例值： 2024-10-30 00:00:00
UpdateTime 是 是 String 修改时间。
示例值： 2024-11-01 00:00:00

ConsumerGroupResponse

消费组返回结果实体

被如下接口引用：DescribeConsumerGroup

名称 必选 允许NULL 类型 描述
TotalCount 是 否 Int64 符合条件的消费组数量
示例值： 1
TopicList 是 是 Array of ConsumerGroupTopic 主题列表
示例值：查看
GroupList 是 是 Array of ConsumerGroup 消费分组List
示例值：查看
TotalPartition 是 是 Int64 所有分区数量
示例值： 0
PartitionListForMonitor 是 是 Array of Partition 监控的分区列表
示例值：查看
TotalTopic 是 是 Int64 主题总数
示例值： 1
TopicListForMonitor 是 是 Array of ConsumerGroupTopic 监控的主题列表
示例值：查看
GroupListForMonitor 是 是 Array of Group 监控的组列表
示例值：查看

ConsumerGroupTopic

消费组主题对象

被如下接口引用：DescribeConsumerGroup

名称 必选 允许NULL 类型 描述
TopicId 是 否 String 主题ID
示例值： topic-test
TopicName 是 否 String 主题名称
示例值： topic-test

InstanceDeleteResponse

删除实例返回任务

被如下接口引用：DeleteInstance

名称 必选 允许NULL 类型 描述
FlowId 是 是 Int64 删除实例返回的任务Id
示例值： 6970

AclRuleDO

acl规则

被如下接口引用：DescribeTopicAttributes

名称 必选 允许NULL 类型 描述
Id 否 否 Int64 id
示例值： 2
RuleName 否 否 String 规则名称
示例值： rule1
InstanceId 否 否 String 实例类型
示例值： ckafka-test
PatternType 否 否 String 模式类型
示例值： preset
Pattern 否 否 String 模式
示例值： 1
ResourceType 否 否 String 资源类型
示例值： test
AclList 否 否 String acl列表
示例值： [1]
CreateTimeStamp 否 否 String 创建时间
示例值： 1756798015
RuleList 否 否 Acl 规则列表
示例值：查看
IsApplied 否 否 Int64 是否应用
示例值： 1
UpdateTimeStamp 否 否 String 更新时间
示例值： 1756798015
Comment 否 否 String 描述
示例值： acl信息
TopicName 否 否 String topicname
示例值： topic1
TopicCount 否 否 Int64 topic数量
示例值： 10
PatternTypeTitle 否 否 String 扩展acl匹配模式：前缀匹配
示例值： PRESET

BillingOrderConfig

计费订单

被如下接口引用：DescribeOrderConfig

名称 必选 允许NULL 类型 描述
Inquiry 否 否 String 订单价格信息
示例值： 1
OrderConfig 否 否 String 订单
示例值： 1
CategoryId 否 否 Int64 类别Id
示例值： 1

K8sclusterDetail

K8s 集群详情。

被如下接口引用：DescribeK8sClusters

名称 必选 允许NULL 类型 描述
K8sClusterId 否 否 String 专业版实例所在的K8s集群Id
示例值： 无
K8sClusterName 否 否 String 专业版实例所在的K8s集群名
示例值： 无

TopicAttributesRes

主题属性返回结果实体

被如下接口引用：DescribeTopicAttributes

名称 必选 允许NULL 类型 描述
TopicId 是 否 String 主题 ID
示例值： topic-test
CreateTime 是 否 Int64 创建时间
示例值： 2021-7-26  4:16:58
Note 是 是 String 主题备注
示例值： note-test
PartitionNum 是 否 Int64 分区个数
示例值： 1
EnableWhiteList 是 否 Int64 IP 白名单开关，1：打开； 0：关闭
示例值： 1
IpWhiteList 是 否 Array of String IP 白名单列表
示例值： ["10.0.0.50"]
Config 是 否 Config topic 配置数组
示例值：查看
Partitions 是 否 Array of TopicPartitionDO 分区详情
示例值：查看
ReplicaNum 否 否 Int64 副本数量
示例值： 3
EnableAclRule 否 否 Int64 开启acl
示例值： 0
QuotaConfig 否 否 ClientQuotaConfigResp 客户端配额配置
示例值：查看
AclRuleList 否 否 Array of AclRuleDO acl规则
示例值：查看

SalesInfo

售卖信息

被如下接口引用：DescribeCkafkaZone

名称 必选 允许NULL 类型 描述
Flag 否 是 Bool 是否售卖
示例值： false
Version 否 是 String 版本
示例值： 2.4.1
Platform 否 是 String 实例规格
示例值： profession
SoldOut 否 是 Bool 是否售罄
示例值： false

SubscribedInfo

订阅信息实体

被如下接口引用：DescribeConsumerGroup

名称 必选 允许NULL 类型 描述
TopicName 是 否 String 订阅的主题名
示例值： topic-test
Partition 是 是 Array of Int64 订阅的分区
示例值： [0]
PartitionOffset 是 是 Array of PartitionOffset 分区offset信息
示例值：查看
TopicId 否 否 String topic的id
示例值： topic-0cpolok4

TradeCreateResponse

创建或修改计量计费类型实例的响应内容

被如下接口引用：HourCreate、HourModify

名称 必选 允许NULL 类型 描述
DealNames 否 否 Array of String 后付费订单列表
示例值： test
FlowId 否 否 String 发货任务ID号（为兼容单个资源开通情况保留）
示例值： 1
FlowIds 是 否 Array of String 发货任务ID号列表
示例值： []
ResourceIds 否 否 Array of String 资源列表
示例值： []
BillId 否 否 String 交易流水号（一般为大订单号）
示例值： 1

Config

高级配置对象

被如下接口引用：DescribeTopicAttributes、DescribeTopicDetail

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

AclResponse

ACL返回结果集

被如下接口引用：DescribeACL

名称 必选 允许NULL 类型 描述
TotalCount 是 否 Int64 符合条件的总数据条数
示例值： 1
AclList 是 是 Array of Acl ACL列表
示例值：查看

TopicPartitionDO

分区详情

被如下接口引用：DescribeTopicAttributes

名称 必选 允许NULL 类型 描述
Partition 是 否 Int64 Partition ID
示例值： 0
LeaderStatus 是 否 Int64 Leader 运行状态
示例值： 0
IsrNum 是 否 Int64 ISR 个数
示例值： 2
ReplicaNum 是 否 Int64 副本个数
示例值： 2

UserResponse

用户返回实体

被如下接口引用：DescribeUser

名称 必选 允许NULL 类型 描述
Users 是 是 Array of User 符合条件的用户列表
示例值：查看
TotalCount 是 否 Int64 符合条件的总用户数
示例值： 1

Assignment

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

被如下接口引用：DescribeGroupInfo

名称 必选 允许NULL 类型 描述
Version 是 否 Int64 assingment版本信息
示例值： 0
Topics 是 是 Array of GroupInfoTopics topic信息列表
示例值：查看

ConsumerGroup

用户组实体

被如下接口引用：DescribeConsumerGroup

名称 必选 允许NULL 类型 描述
ConsumerGroupName 是 否 String 用户组名称
示例值： consumerGroup-test
SubscribedInfo 是 否 Array of SubscribedInfo 订阅信息实体
示例值：查看

DescribeGroup

DescribeGroup返回实体

被如下接口引用：DescribeGroup

名称 必选 允许NULL 类型 描述
Group 是 否 String groupId
示例值： group-test
Protocol 是 否 String 该 group 使用的协议。
示例值： consumer

K8sclusterDetailResponse

K8s 集群返回值结构体。

被如下接口引用：DescribeK8sClusters

名称 必选 允许NULL 类型 描述
K8sClusters 否 否 K8sclusterDetail K8s 集群列表。
示例值：查看
TotalCount 否 否 Int64 K8s 集群总数。
示例值： 无

CommunityResponse

是否社区版的返回对象

被如下接口引用：DescribeIfCommunity

名称 必选 允许NULL 类型 描述
InstanceId 是 否 String 实例ID
示例值： ckafka-test
IfCommunity 是 否 Bool 是否社区版
示例值： false

Route

路由实体对象

被如下接口引用：DescribeRoute

名称 必选 允许NULL 类型 描述
AccessType 是 否 Int64 实例接入方式
0：PLAINTEXT (明文方式，没有带用户信息老版本及社区版本都支持)
1：SASL_PLAINTEXT（明文方式，不过在数据开始时，会通过SASL方式登录鉴权，仅社区版本支持）
2：SSL（SSL加密通信，没有带用户信息，老版本及社区版本都支持）
3：SASL_SSL（SSL加密通信，在数据开始时，会通过SASL方式登录鉴权，仅社区版本支持）
示例值： 1
RouteId 是 否 Int64 路由ID
示例值： 301
VipType 是 否 Int64 vip网络类型（1:外网TGW  2:基础网络 3:VPC网络 4:云平台支持环境(一般用于内部实例) 5:SSL外网访问方式访问 6:黑石环境vpc）
示例值： 1
VipList 是 否 Array of VipEntity 虚拟IP列表
示例值：查看
Domain 是 是 String 域名
示例值： cloud.com
DomainPort 是 是 Int64 域名port
示例值： 0
InternalFlag 否 否 Int64 内部路由的标志(0:非内部  1:内部路由),内部路由不在DescribeRoute接口展示,用户控制台无法查看删除此路由
示例值： 0
UsedFor 否 否 String 内部路由的用途(非内部路由为空串  内部目前有:internalDefault#默认,crossRegion#跨地域容灾)
示例值： crossRegion
Processing 否 否 Int64 路由创建进度
示例值： 1
DeleteTimestamp 否 否 String 删除时间戳
示例值： 1300313212123
BrokerVipList 否 否 Array of VipEntity broker vip映射列表
示例值：查看
VpcId 否 否 String vpcid
示例值： vpc-test
Subnet 否 否 String 子网信息
示例值： subnet-test
Note 否 否 String 备注
示例值： 数据传输路由

Tag

实例详情中的标签对象

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

名称 必选 允许NULL 类型 描述
TagKey 是 否 String 标签的key
示例值： tagkey-test
TagValue 是 否 String 标签的值
示例值： tagvalue-test

Filter

查询过滤器

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

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

被如下接口引用：DescribeInstanceDetail、DescribeInstancesDetail

名称 必选 允许NULL 类型 描述
Name 是 否 String 需要过滤的字段。
示例值： GroupState
Values 是 否 Array of String 字段的过滤值。
示例值： ["Empty"]

GroupOffsetTopic

消费分组主题对象

被如下接口引用：DescribeGroupOffsets

名称 必选 允许NULL 类型 描述
Topic 是 否 String 主题名称
示例值： topic-test
Partitions 是 是 Array of GroupOffsetPartition 该主题分区数组，其中每个元素为一个 json object
示例值：查看

ConnectorStatus

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

被如下接口引用：DescribeConnectorStatus

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

PartDetail

价格对象详情

被如下接口引用：DescribeCkafkaPrice

名称 必选 允许NULL 类型 描述
Disk 是 是 PriceObject 硬盘价格
示例值：查看
CloudKafka 是 是 PriceObject ckafka价格
示例值：查看

PriceDetail

价格详情

被如下接口引用：DescribeCkafkaPrice

名称 必选 允许NULL 类型 描述
SinglePrice 是 否 Int64 单价
示例值： 35
UsedAmount 是 否 Int64 使用数量
示例值： 800
Cost 是 否 Int64 花费
示例值： 28000

DynamicRetentionTime

动态消息保留时间

被如下接口引用：DescribeInstanceAttributes

名称 必选 允许NULL 类型 描述
Enable 否 否 Int64 /开启或者关闭(0: 关闭，1: 开启)
示例值： 0
DiskQuotaPercentage 否 否 Int64 磁盘配额百分比(即触发条件)
示例值： 75
StepForwardPercentage 否 否 Int64 往前调整步长百分比
示例值： 10
BottomRetention 否 否 Int64 保底时长，单位分钟
示例值： 20

InstanceDetail

实例详情

被如下接口引用：DescribeInstanceDetail、DescribeInstancesDetail

名称 必选 允许NULL 类型 描述
InstanceId 是 否 String 实例id
示例值： ckafka-test
InstanceName 是 否 String 实例名称
示例值： ckafka测试
Vip 是 否 String 访问实例的vip 信息
示例值： 10.0.0.5
Vport 是 否 String 访问实例的端口信息
示例值： 9092
VipList 是 否 Array of VipEntity 虚拟IP列表
示例值：查看
Status 是 否 Int64 实例的状态。0：创建中，1：运行中，2：删除中：5隔离中， -1 创建失败
示例值： 1
Bandwidth 是 否 Int64 实例带宽，单位Mbps
示例值： 300
DiskSize 是 否 Int64 实例的存储大小，单位GB
示例值： 800
ZoneId 是 否 Int64 可用区域ID
示例值： 100003
VpcId 是 否 String vpcId，如果为空，说明是基础网络
示例值： vpc-test
SubnetId 是 否 String 子网id
示例值： subnet-test
RenewFlag 是 否 Int64 实例是否续费，int  枚举值：1表示自动续费，2表示明确不自动续费
示例值： 1
Healthy 是 否 Int64 实例状态 int：0表示健康，1表示告警，2 表示实例状态异常
示例值： 1
HealthyMessage 是 否 String 实例状态信息
示例值： "健康"
CreateTime 是 否 Int64 实例创建时间时间
示例值： 1566144000
ExpireTime 是 否 Int64 实例过期时间
示例值： 1566144000
IsInternal 是 否 Int64 是否为内部客户。值为1 表示内部客户
示例值： 1
TopicNum 是 否 Int64 Topic个数
示例值： 10
Tags 是 否 Array of Tag 标识tag
示例值：查看
Version 是 是 String kafka版本信息
示例值： 1.1.1
ZoneIds 是 是 Array of Int64 跨可用区
示例值： [100003,100004]
Cvm 是 是 Int64 ckafka售卖类型
示例值： 0
CpuArch 否 否 Int64 集群的 CPU 架构。1:x86; 2:arm; 按位标记架构类型，例：3 二进制为 0011，表示 x86、arm 混合架构
示例值： 1
ClusterId 否 是 Int64 实例所在集群的Id
示例值： 1
ClusterName 否 是 String 实例所在集群的名称
示例值： test
PayMode 否 否 Int64 付费模式。-1:非付费实例(默认)；0:后付费实例；1:预付费实例
示例值： 1
DiskType 否 否 String 磁盘类型
示例值： SSD
K8sClusterId 否 否 String 专业版实例所在的K8s集群Id
示例值： global
K8sClusterName 否 否 String 专业版实例所在的K8s集群名
示例值： global
MaxPartitionNumber 否 否 Int64 最大partition数量
示例值： 60
SpecificationsType 否 是 String 规格类型
示例值： profession
ProjectId 否 是 String 项目id
示例值： 1
AllowDowngrade 否 否 Bool 是否允许降配
示例值： false
MaxTopicNumber 否 否 Int64 最大topic数量
示例值： 25
ProjectName 否 是 String 项目名
示例值： test
AppId 否 否 Int64 展示appId字段
示例值： 1255000011
MaxAvailableDiskSize 否 否 Int64 最大可用磁盘
示例值： 87
InstanceType 否 否 String 实例类型
示例值： profession
PartitionNumber 否 否 Int64 当前partition数量
示例值： 0
Features 否 是 Array of String 功能
示例值： []

InstanceResponse

聚合的实例状态返回结果

被如下接口引用：DescribeInstances

名称 必选 允许NULL 类型 描述
InstanceList 是 是 Array of Instance 符合条件的实例列表
示例值：查看
TotalCount 是 是 Int64 符合条件的结果总数
示例值： 1

AppIdResponse

AppId的查询结果

被如下接口引用：DescribeAppInfo

名称 必选 允许NULL 类型 描述
TotalCount 是 否 Int64 符合要求的所有AppId数量
示例值： 1
AppIdList 是 是 Array of Int64 符合要求的App Id列表
示例值： [1000000001]

GroupRes

DescribeGroup的返回

被如下接口引用：DescribeGroup

名称 必选 允许NULL 类型 描述
TotalCount 是 是 Int64 计数
示例值： 1
GroupList 是 是 Array of DescribeGroup GroupList
示例值：查看
GroupCountQuota 否 否 Int64 200
示例值： 消费组配额

PriceResponse

价格返回结果

被如下接口引用：DescribeCkafkaPrice

名称 必选 允许NULL 类型 描述
Price 是 否 Int64 价格
示例值： 2869900
PartDetail 是 否 PartDetail 组成详情
示例值：查看
HasUserPrice 是 否 Bool 是否用户价格
示例值： false
TotalCost 是 否 Int64 总花费
示例值： 2869900
Currency 是 否 String 货币
示例值： C
TimeUnit 是 否 String 商品的时间单位
示例值： m
TimeSpan 是 否 Int64 商品的时间大小
示例值： 1
GoodsNum 是 否 Int64 资源实例个数
示例值： 1
FromType 是 否 Int64 类型
示例值： 0
Pid 是 否 Int64 pid
示例值： 15128
RealTotalCost 是 否 Int64 真实总花费
示例值： 2869900
ProductCode 是 否 String 产品代码
示例值： p_ckafka
SubProductCode 是 否 String 子产品代码
示例值： sp_ckafka_standard
Policy 是 否 Float 优惠
示例值： 100
PolicyDetail 是 否 PolicyDetail 优惠详情
示例值：查看
UnitPrice 是 否 Int64 单价
示例值： 2869900

GroupInfoResponse

GroupInfo返回数据的实体

被如下接口引用：DescribeGroupInfo

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

ClientQuotaConfigResp

topic客户端配额设置

被如下接口引用：DescribeTopicAttributes

名称 必选 允许NULL 类型 描述
QuotaProducerByteRate 否 否 Int64 生产限流大小
示例值： 100
QuotaConsumerByteRate 否 否 Int64 消费限流大小
示例值： 100

ZoneResponse

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

被如下接口引用：DescribeCkafkaZone

名称 必选 允许NULL 类型 描述
ZoneList 是 否 Array of ZoneInfo zone列表
示例值：查看
MaxBuyInstanceNum 是 否 Int64 最大购买实例个数
示例值： 100
MaxBandwidth 是 否 Int64 最大购买带宽 单位Mb/s
示例值： 9600
UnitPrice 是 否 Price 后付费单位价格
示例值：查看
MessagePrice 是 否 Price 后付费消息单价
示例值：查看
ClusterInfo 是 是 Array of ClusterInfo 用户独占集群信息
示例值：查看
Profession 否 是 String 专业版信息
示例值： "{{"Bandwidth":{"Maximum":1200}}"
SupportStoreQuantity 否 是 Int64 是否支持按量存储实例(1支持，0不支持，默认0)
示例值： 0
ElasticBandwidthSwitch 否 是 Int64 购买页支持开启弹性带宽：1-支持；0-不支持
示例值： 0
SpecificationType 否 否 Array of String 规格类型
示例值： ["standard","profession"]

Acl

ACL对象实体

被如下接口引用：DescribeACL、DescribeTopicAttributes

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

GroupInfoMember

consumer信息

被如下接口引用：DescribeGroupInfo

名称 必选 允许NULL 类型 描述
MemberId 是 否 String coordinator 为消费分组中的消费者生成的唯一 ID
示例值： consumer-test
ClientId 是 否 String 客户消费者 SDK 自己设置的 client.id 信息
示例值： consumer-client-test
ClientHost 是 否 String 一般存储客户的 IP 地址
示例值： 10.0.0.30
Assignment 是 否 Assignment 存储着分配给该消费者的 partition 信息
示例值：查看

Instance

实例对象

被如下接口引用：DescribeInstances

名称 必选 允许NULL 类型 描述
InstanceId 是 否 String 实例id
示例值： ckafka-test
InstanceName 是 否 String 实例名称
示例值： ckafka测试
Status 是 否 Int64 实例的状态。0：创建中，1：运行中，2：删除中 ， 5 隔离中，-1 创建失败
示例值： 1
IfCommunity 是 是 Bool 是否开源实例。开源：true，不开源：false
示例值： false

InstanceAttributesRes

实例属性返回结果对象

被如下接口引用：DescribeInstanceAttributes

名称 必选 允许NULL 类型 描述
InstanceId 是 否 String 实例ID
示例值： ckafka-test
InstanceName 是 否 String 实例名称
示例值： ckafka测试
VipList 是 否 Array of VipEntity 接入点 VIP 列表信息
示例值：查看
Vip 是 否 String 虚拟IP
示例值： 10.0.0.5
Vport 是 否 String 虚拟端口
示例值： 9092
Status 是 否 Int64 实例的状态。0：创建中，1：运行中，2：删除中
示例值： 1
Bandwidth 是 否 Int64 实例带宽，单位：Mbps
示例值： 100
DiskSize 是 否 Int64 实例的存储大小，单位：GB
示例值： 200
ZoneId 是 否 Int64 可用区
示例值： 100003
VpcId 是 否 String VPC 的 ID，为空表示是基础网络
示例值： vpc-test
SubnetId 是 否 String 子网 ID， 为空表示基础网络
示例值： subnet-test
Healthy 是 否 Int64 实例健康状态， 1：健康，2：告警，3：异常
示例值： 1
HealthyMessage 是 否 String 实例健康信息，当前会展示磁盘利用率，最大长度为256
示例值： healthy
CreateTime 是 否 Uint64 创建时间
示例值： 2019-08-19 00:00:00
MsgRetentionTime 是 否 Int64 消息保存时间,单位为分钟
示例值： 4320
Config 是 否 InstanceConfigDO 自动创建 Topic 配置， 若该字段为空，则表示未开启自动创建
示例值：查看
RemainderPartitions 是 否 Int64 剩余创建分区数
示例值： 310
RemainderTopics 是 否 Int64 剩余创建主题数
示例值： 190
CreatedPartitions 是 否 Int64 当前创建分区数
示例值： 90
CreatedTopics 是 否 Int64 当前创建主题数
示例值： 10
Tags 是 是 Array of Tag 标签数组
示例值：查看
ExpireTime 是 是 Uint64 过期时间
示例值： 1566144000
ZoneIds 是 是 Array of Int64 跨可用区
示例值： [100003,100004]
Version 是 是 String kafka版本信息
示例值： 1.1.1
MaxGroupNum 是 是 Int64 最大分组数
示例值： 500
Cvm 是 是 Int64 售卖类型
示例值： 1
CpuArch 否 否 Int64 集群的 CPU 架构。1:x86; 2:arm; 按位标记架构类型，例：3 二进制为 0011，表示 x86、arm 混合架构
示例值： 1
ClusterId 否 是 Int64 实例所在集群的Id
示例值： 1
ClusterName 否 是 String 实例所在集群的名称
示例值： test
PayMode 否 否 Int64 付费模式。-1:非付费实例(默认)；0:后付费实例；1:预付费实例
示例值： 1
K8sClusterId 否 否 String 专业版实例所属 K8s 集群 ID
示例值： global
K8sClusterName 否 否 String 专业版实例所属 K8s 集群名称
示例值： global
RetentionTimeConfig 否 否 DynamicRetentionTime 动态时间配置
示例值：查看
DynamicDiskConfig 否 否 DynamicDiskConfig 动态磁盘配置
示例值：查看
SystemMaintenanceTime 否 否 String 系统维护时间
示例值： 1
ElasticBandwidthOpenStatus 否 否 Int64 弹性带宽状态；    UN_OPEN(1, "未开通"),     OPENING(16, "开通中"),     OPEN_SUCCESS(32, "开通成功"),     OPEN_FAILED(64, "开通失败")
示例值： 16
ProjectName 否 否 String 项目名称
示例值： projectName1
MaxMessageByte 否 否 Int64 允许最大消息
示例值： 12582912L
ProjectId 否 否 String 项目ID字段
示例值： 12
RemainingTopics 否 否 Int64 剩余topic配额
示例值： 198
PublicNetworkChargeType 否 否 String 公网带宽计费类型
示例值： BANDWIDTH_POSTPAID_BY_HOUR
RemainingPartitions 否 否 Int64 剩余parition配额
示例值： 2000
InstanceType 否 否 String 实例类型
示例值： profession
DiskType 否 否 String 磁盘类型
示例值： SSD
CompressionType 否 否 String 支持的压缩算法类型
示例值： snappy
InstanceChargeType 否 否 String 购买付费类型 PREPAID(包年包月)/POSTPAID_BY_HOUR(按量付费)
示例值： PREPAID
ElasticBandwidthSwitch 否 否 Int64 购买页支持开启弹性带宽：1-支持；0-不支持
示例值： 1
DeleteRouteTimestamp 否 否 String 删除路由时间设置
示例值： 0000-00-00 00:00:00
MaxConnection 否 否 Int64 最大连接数
示例值： 5000
Features 否 否 Array of String 功能
示例值： 1
PublicNetwork 否 否 Int64 购买页公网带宽
示例值： 1

TopicDetail

主题详情

被如下接口引用：DescribeTopicDetail

名称 必选 允许NULL 类型 描述
TopicName 是 否 String 主题名称
示例值： topic-test
TopicId 是 否 String 主题ID
示例值： topic-test
PartitionNum 是 否 Int64 分区数
示例值： 6
ReplicaNum 是 否 Int64 副本数
示例值： 2
Note 是 是 String 备注
示例值： note-test
CreateTime 是 否 Int64 创建时间
示例值： 1566144000
EnableWhiteList 是 否 Bool 是否开启ip鉴权白名单，true表示开启，false表示不开启
示例值： false
IpWhiteListCount 是 否 Int64 ip白名单中ip个数
示例值： 0
ForwardCosBucket 是 是 String 数据备份cos bucket: 转存到cos 的bucket地址
示例值： cos-bucket-test
ForwardStatus 是 否 Int64 数据备份cos 状态： 1 不开启数据备份，0 开启数据备份
示例值： 1
ForwardInterval 是 否 Int64 数据备份到cos的周期频率
示例值： 0
Config 是 是 Config 高级配置
示例值：查看
Status 否 否 Int64 状态
示例值： 0
Tags 否 否 Tags tag标签
示例值：查看
RetentionTimeConfig 否 否 RetentionTimeConfig 保留时间配置
示例值：查看

TopicDetailResponse

主题详情返回实体

被如下接口引用：DescribeTopicDetail

名称 必选 允许NULL 类型 描述
TopicList 是 是 Array of TopicDetail 返回的主题详情列表
示例值：查看
TotalCount 是 否 Int64 符合条件的所有主题详情数量
示例值： 1

Group

组实体

被如下接口引用：DescribeConsumerGroup

名称 必选 允许NULL 类型 描述
GroupName 是 否 String 组名称
示例值： group-test

InstanceDetailResponse

实例详情返回结果

被如下接口引用：DescribeInstanceDetail、DescribeInstancesDetail

名称 必选 允许NULL 类型 描述
TotalCount 是 否 Int64 符合条件的实例总数
示例值： 1
InstanceList 是 否 Array of InstanceDetail 符合条件的实例详情列表
示例值：查看

RetentionTimeConfig

topic消息保留时长配置信息

被如下接口引用：DescribeTopicDetail

名称 必选 允许NULL 类型 描述
Expect 否 否 Int64 用户配置值即期望值
示例值： 1440
Current 否 否 Int64 当前值
示例值： 1440
ModTimeStamp 否 否 Int64 变更修改时间
示例值： 1755244634000

Topic

返回的topic对象

被如下接口引用：DescribeTopic

名称 必选 允许NULL 类型 描述
TopicId 是 否 String 主题的ID
示例值： topic-test
TopicName 是 否 String 主题的名称
示例值： topic-test
Note 是 是 String 备注
示例值： note-test

VipEntity

虚拟IP实体

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

名称 必选 允许NULL 类型 描述
Vip 是 否 String 虚拟IP
示例值： 1.0.0.5
Vport 是 否 String 虚拟端口
示例值： 9092

CreateTopicResp

创建主题返回

被如下接口引用：CreateTopic

名称 必选 允许NULL 类型 描述
TopicId 是 否 String 主题Id
示例值： topic-test

DynamicDiskConfig

动态磁盘配置

被如下接口引用：DescribeInstanceAttributes

名称 必选 允许NULL 类型 描述
Enable 否 否 Int64 是否启用功能，1 启用，0 未启用，缺省 未启用
示例值： 0
DiskQuotaPercentage 否 否 Int64 磁盘负载达到百分比，启用动态扩容
示例值： 60
StepForwardPercentage 否 否 Int64 磁盘动态扩容步进大小
示例值： 10
MaxDiskSpace 否 否 Int64 最大扩容硬盘大小
示例值： 1000

GroupInfoTopics

GroupInfo内部topic对象

被如下接口引用：DescribeGroupInfo

名称 必选 允许NULL 类型 描述
Topic 是 否 String 分配的 topic 名称
示例值： topic-test
Partitions 是 是 Array of Int64 分配的 partition 信息
示例值： [0]

ConsumerRecord

消息记录

被如下接口引用：FetchMessageByOffset、FetchMessageListByOffset、FetchMessageListByTimestamp

名称 必选 允许NULL 类型 描述
Topic 是 否 String 主题名
示例值： topic-test
Partition 是 否 Uint64 分区id
示例值： 0
Offset 是 否 Uint64 位点
示例值： 0
Key 否 是 String 消息key
示例值： key-test
Value 否 是 String 消息value
示例值： value-test
Timestamp 否 是 Uint64 消息时间戳
示例值： 1657542315
Headers 否 是 String 消息headers
示例值： header-test

JgwOperateResponse

操作型结果返回值

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

名称 必选 允许NULL 类型 描述
ReturnCode 是 否 String 返回的code，0为正常，非0为错误
示例值： 0
ReturnMessage 是 否 String 成功消息
示例值： success
Data 是 是 OperateResponseData 操作型返回的Data数据,可能有flowId等
示例值：查看

User

用户实体

被如下接口引用：DescribeUser

名称 必选 允许NULL 类型 描述
UserId 是 否 Int64 用户id
示例值： 1
Name 是 否 String 用户名称
示例值： name-test
CreateTime 是 否 Datetime 创建时间
示例值： 2019-08-19 00:00:00
UpdateTime 是 否 Datetime 最后更新时间
示例值： 2019-08-19 00:00:00
CreatedTimestamp 否 否 Int64 创建时间戳
示例值： 1757340058
ModifiedTimestamp 否 否 Int64 最后更新时间戳
示例值： 1757340058

Tags

tag配置

被如下接口引用：DescribeTopicDetail

名称 必选 允许NULL 类型 描述
TagKey 否 否 String tag配置key
示例值： test
TagValue 否 否 String tag配置value
示例值： test

ConnectorResponse

Connector返回结果对象

被如下接口引用：DescribeConnector

名称 必选 允许NULL 类型 描述
TotalCount 是 否 Int64 符合条件的 connector 数量。
示例值： 1
ConnectorList 是 是 Array of Connector 数据同步任务列表。
示例值：查看

ZoneInfo

zone信息实体

被如下接口引用：DescribeCkafkaZone

名称 必选 允许NULL 类型 描述
ZoneId 是 否 String zone的id
示例值： 100003
IsInternalApp 是 否 Int64 是否内部APP
示例值： 1
AppId 是 否 Int64 app id
示例值： 1000000001
Flag 是 否 Bool 标识
示例值： false
ZoneName 是 否 String zone名称
示例值： region3
ZoneStatus 是 否 Int64 zone状态
示例值： 3
Exflag 是 否 String 额外标识
示例值： 1
SoldOut 是 否 String json对象，key为机型，value true为售罄，false为未售罄
示例值： true
ExtraFlag 否 是 String 额外Flag
示例值： "0"
SalesInfo 否 是 Array of SalesInfo 售卖信息
示例值：查看

InstanceTypeConfigResponse

获取实例规格配置返回结果

被如下接口引用：DescribeCkafkaTypeConfigs

名称 必选 允许NULL 类型 描述
InstanceTypeConfigSet 是 是 Array of InstanceTypeConfigDO 实例规格配置结果集合
示例值：查看
MaximumTopicPartition 是 是 Int64 最大主题分区
示例值： 24
MaximumInstanceConsumerGroup 是 是 Int64 最大实例消费组
示例值： 50

DescribeBrokerResponse

DescribeBrokerResponse

被如下接口引用：DescribeBrokers

名称 必选 允许NULL 类型 描述
ClusterId 是 否 Int64 ClusterId
示例值： 1
ZoneId 是 否 Int64 ZoneId
示例值： 12121312
ClusterName 是 是 String ClusterName
示例值： test
BrokerIp 是 否 String BrokerIp
示例值： 1.1.1.1
BrokerId 是 否 Int64 BrokerId
示例值： 1
MaxNetworkFlow 是 否 Uint64 MaxNetworkFlow
示例值： 100
MaxDiskSpace 是 否 Uint64 MaxDiskSpace
示例值： 100
MinPort 是 否 Uint64 MinPort
示例值： 13000
MaxPort 是 否 Uint64 MaxPort
示例值： 13500
AvailableNetworkFlow 是 否 Uint64 AvailableNetworkFlow
示例值： 100
AvailableDiskSpace 是 否 Uint64 AvailableDiskSpace
示例值： 100

AppIdIsVipResponse

是否大客户查询结果

被如下接口引用：DescribeAppIdIsVip

名称 必选 允许NULL 类型 描述
VipFlag 是 否 Int64 0表示小客户 1 表示大客户
示例值： 0
InternalApp 是 否 Int64 0 : 表示公有云客户， 1 表示内部客户
示例值： 0

GroupOffsetResponse

消费组偏移量返回结果

被如下接口引用：DescribeGroupOffsets

名称 必选 允许NULL 类型 描述
TotalCount 是 否 Int64 符合调节的总结果数
示例值： 1
TopicList 是 是 Array of GroupOffsetTopic 该主题分区数组，其中每个元素为一个 json object
示例值：查看

RouteRes

路由信息返回对象

被如下接口引用：DescribeRoute

名称 必选 允许NULL 类型 描述
Routers 是 是 Array of Route 路由信息列表
示例值：查看

Price

消息价格实体

被如下接口引用：DescribeCkafkaZone

名称 必选 允许NULL 类型 描述
RealTotalCost 否 否 Float 折扣价
示例值： 0
TotalCost 否 否 Float 原价
示例值： 0

ConnectorConfigsResponse

Connector配置信息对象

被如下接口引用：DescribeConnectorConfigs

名称 必选 允许NULL 类型 描述
ConnectorClass 是 否 String 执行该任务的 class 名称。
示例值： com.cloud.ckafka.replicator.K2KSourceConnector
DestInstance 是 否 String 目的实例名称。
示例值： ckafka-test
TopicConfig 是 否 String 主题配置。
示例值： {"test":{},"test1":{}}
ConnectorVersion 是 否 String connector 版本。
示例值： 0.10.2.1
SrcInstance 是 否 String 源实例。
示例值： ckafka-test
OffsetReset 是 否 String 任务同步启动时候的 offset 设置
示例值： latest
SourceBroker 是 否 String 源实例访问 broker 地址和端口。
示例值： 10.14.211.55:6017
KeepPartition 是 否 Bool 源和目的 topic 的 partition 数量是否要求保持一致。
true：保持一致；false：不一致。
示例值： true
Name 是 否 String connector 名称。
示例值： connector-ckafka-test
AutoCreate 是 否 Bool 是否开启主题自动创建。true 表示开启，false 表示不开启。
示例值： false

InstanceTypeConfigDO

实例规格配置对象

被如下接口引用：DescribeCkafkaTypeConfigs

名称 必选 允许NULL 类型 描述
Type 是 否 String 型号
示例值： general
Desc 是 否 String 类型描述
示例值： 入门型
Bandwidth 是 否 Int64 带宽流量大小，单位Mbqs
示例值： 320
DiskSize 是 否 Int64 磁盘大小，单位GB
示例值： 300
Pid 是 否 Int64 类型对应的pid信息
示例值： 15127
MaximumInstancePartition 是 否 Int64 该规格可以创建的分区数量配额
示例值： 60
MaximumInstanceTopic 是 否 Int64 该规格可以创建的主题数量配额
示例值： 25