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

数据结构

最近更新时间: 2025-02-18 17:50:23

CommunityResponse

是否社区版的返回对象

被如下接口引用：DescribeIfCommunity

名称 必选 允许NULL 类型 描述
InstanceId 是 否 String 实例ID
IfCommunity 是 否 Bool 是否社区版

VipEntity

虚拟IP实体

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

名称 必选 允许NULL 类型 描述
Vip 是 否 String 虚拟IP
Vport 是 否 String 虚拟端口

Assignment

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

被如下接口引用：DescribeGroupInfo

名称 必选 允许NULL 类型 描述
Version 是 否 Int64 assingment版本信息
Topics 是 是 Array of GroupInfoTopics topic信息列表

DescribeGroup

DescribeGroup返回实体

被如下接口引用：DescribeGroup

名称 必选 允许NULL 类型 描述
Group 是 否 String groupId
Protocol 是 否 String 该 group 使用的协议。

AppIdIsVipResponse

是否大客户查询结果

被如下接口引用：DescribeAppIdIsVip

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

CreateTopicResp

创建主题返回

被如下接口引用：CreateTopic

名称 必选 允许NULL 类型 描述
TopicId 是 否 String 主题Id

TopicDetailResponse

主题详情返回实体

被如下接口引用：DescribeTopicDetail

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

ConsumerGroupResponse

消费组返回结果实体

被如下接口引用：DescribeConsumerGroup

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

ConnectorConfigsResponse

Connector配置信息对象

被如下接口引用：DescribeConnectorConfigs

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

DescribeBrokerResponse

DescribeBrokerResponse

被如下接口引用：DescribeBrokers

名称 必选 允许NULL 类型 描述
ClusterId 是 否 Int64 ClusterId
ZoneId 是 否 Int64 ZoneId
ClusterName 是 是 String ClusterName
BrokerIp 是 否 String BrokerIp
BrokerId 是 否 Int64 BrokerId
MaxNetworkFlow 是 否 Uint64 MaxNetworkFlow
MaxDiskSpace 是 否 Uint64 MaxDiskSpace
MinPort 是 否 Uint64 MinPort
MaxPort 是 否 Uint64 MaxPort
AvailableNetworkFlow 是 否 Uint64 AvailableNetworkFlow
AvailableDiskSpace 是 否 Uint64 AvailableDiskSpace

OperateResponseData

操作类型返回的Data结构

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

名称 必选 允许NULL 类型 描述
FlowId 是 是 Int64 FlowId

ConsumerRecord

消息记录

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

名称 必选 允许NULL 类型 描述
Topic 是 否 String 主题名
Partition 是 否 Uint64 分区id
Offset 是 否 Uint64 位点
Key 否 是 String 消息key
Value 否 是 String 消息value
Timestamp 否 是 Uint64 消息时间戳
Headers 否 是 String 消息headers

UserResponse

用户返回实体

被如下接口引用：DescribeUser

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

Connector

连接器实例

被如下接口引用：DescribeConnector

名称 必选 允许NULL 类型 描述
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 修改时间。

GroupInfoTopics

GroupInfo内部topic对象

被如下接口引用：DescribeGroupInfo

名称 必选 允许NULL 类型 描述
Topic 是 否 String 分配的 topic 名称
Partitions 是 是 Array of Int64 分配的 partition 信息

Instance

实例对象

被如下接口引用：DescribeInstances

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

InstanceDeleteResponse

删除实例返回任务

被如下接口引用：DeleteInstance

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

ModifyInstanceAttributesConfig

修改实例属性的配置对象

被如下接口引用：ModifyInstanceAttributes

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

Error

返回的错误信息

被如下接口引用：

名称 必选 允许NULL 类型 描述
Code 是 否 String 错误码
Message 是 否 String 错误信息

JgwOperateResponse

操作型结果返回值

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

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

Filter

查询过滤器 >描述键值对过滤器，用于条件过滤查询。例如过滤ID、名称、状态等 > * 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。 > * 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。 >

被如下接口引用：DescribeInstanceDetail、DescribeInstancesDetail

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

PartDetail

价格对象详情

被如下接口引用：DescribeCkafkaPrice

名称 必选 允许NULL 类型 描述
Disk 是 是 PriceObject 硬盘价格
CloudKafka 是 是 PriceObject ckafka价格

AclResponse

ACL返回结果集

被如下接口引用：DescribeACL

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

AppIdResponse

AppId的查询结果

被如下接口引用：DescribeAppInfo

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

InstanceResponse

聚合的实例状态返回结果

被如下接口引用：DescribeInstances

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

SubscribedInfo

订阅信息实体

被如下接口引用：DescribeConsumerGroup

名称 必选 允许NULL 类型 描述
TopicName 是 否 String 订阅的主题名
Partition 是 是 Array of Int64 订阅的分区
PartitionOffset 是 是 Array of PartitionOffset 分区offset信息

DescribeClustersResponse

DescribeClustersResponse

被如下接口引用：

名称 必选 允许NULL 类型 描述
ClusterId 是 否 Int64 ClusterId
ZoneId 是 否 Int64 ZoneId
Type 是 否 Int64 Type
Flag 是 否 Int64 Flag
TypeDescriptor 是 否 String TypeDescriptor
BindAppId 是 否 Int64 BindAppId
Status 是 否 String Status
Controller 是 是 DescribeClustersController Controller
ClusterName 是 否 String ClusterName
Ips 是 否 String Ips

SoldOut

售罄标志

被如下接口引用：

名称 必选 允许NULL 类型 描述
Cvm 是 是 String false未售罄

Group

组实体

被如下接口引用：DescribeConsumerGroup

名称 必选 允许NULL 类型 描述
GroupName 是 否 String 组名称

DescribeBrokersResponses

DescribeBrokersResponses

被如下接口引用：DescribeBrokers

名称 必选 允许NULL 类型 描述
TotalCount 是 否 Int64 总数
Brokers 是 否 Array of DescribeBrokerResponse Brokers

GroupOffsetResponse

消费组偏移量返回结果

被如下接口引用：DescribeGroupOffsets

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

PriceResponse

价格返回结果

被如下接口引用：DescribeCkafkaPrice

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

ZoneResponse

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

被如下接口引用：DescribeCkafkaZone

名称 必选 允许NULL 类型 描述
ZoneList 是 否 Array of ZoneInfo zone列表
MaxBuyInstanceNum 是 否 Int64 最大购买实例个数
MaxBandwidth 是 否 Int64 最大购买带宽 单位Mb/s
UnitPrice 是 否 Price 后付费单位价格
MessagePrice 是 否 Price 后付费消息单价
ClusterInfo 是 是 Array of ClusterInfo 用户独占集群信息

PolicyDetail

折扣详情

被如下接口引用：DescribeCkafkaPrice

名称 必选 允许NULL 类型 描述
Total 是 否 Float 总折扣
User 是 否 Float 用户个人折扣
Common 是 否 Int64 官网基础折扣
Activity 是 否 Int64 Activity
DiscountType 是 是 String 折扣类型
DiscountId 是 是 Int64 折扣ID
PreferentialType 是 是 Int64 优惠类型
DiscountSpecifiedPid 是 是 Int64 指定折扣pid
Combine 是 是 Float Combine

User

用户实体

被如下接口引用：DescribeUser

名称 必选 允许NULL 类型 描述
UserId 是 否 Int64 用户id
Name 是 否 String 用户名称
CreateTime 是 否 Datetime 创建时间
UpdateTime 是 否 Datetime 最后更新时间

PriceDetail

价格详情

被如下接口引用：DescribeCkafkaPrice

名称 必选 允许NULL 类型 描述
SinglePrice 是 否 Int64 单价
UsedAmount 是 否 Int64 使用数量
Cost 是 否 Int64 花费

PriceObject

价格对象

被如下接口引用：DescribeCkafkaPrice

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

TradeCreateResponse

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

被如下接口引用：HourCreate、HourModify

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

ConsumerGroup

用户组实体

被如下接口引用：DescribeConsumerGroup

名称 必选 允许NULL 类型 描述
ConsumerGroupName 是 否 String 用户组名称
SubscribedInfo 是 否 Array of SubscribedInfo 订阅信息实体

CreateTceInstanceResponse

CreateTceInstance回参

被如下接口引用：CreateInstanceTce

名称 必选 允许NULL 类型 描述
FlowId 是 否 Int64 flowId
ResourceIds 是 是 Array of String instanceId数组

Route

路由实体对象

被如下接口引用：DescribeRoute

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

ZoneInfo

zone信息实体

被如下接口引用：DescribeCkafkaZone

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

CreateInstancePreData

创建预付费接口返回的Data

被如下接口引用：

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

DescribeClustersResponses

DescribeClustersResponses

被如下接口引用：

名称 必选 允许NULL 类型 描述
Brokers 是 否 Array of DescribeClustersResponse 集群信息
TotalCount 是 否 Int64 总数

InstanceTypeConfigResponse

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

被如下接口引用：DescribeCkafkaTypeConfigs

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

ConsumerGroupTopic

消费组主题对象

被如下接口引用：DescribeConsumerGroup

名称 必选 允许NULL 类型 描述
TopicId 是 否 String 主题ID
TopicName 是 否 String 主题名称

DescribeClustersController

DescribeClustersController

被如下接口引用：

名称 必选 允许NULL 类型 描述
Id 是 否 Int64 id
Ip 是 否 String ip
Epoch 是 否 Int64 epoch

InstanceDetail

实例详情

被如下接口引用：DescribeInstanceDetail、DescribeInstancesDetail

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

InstanceDetailResponse

实例详情返回结果

被如下接口引用：DescribeInstanceDetail、DescribeInstancesDetail

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

Topic

返回的topic对象

被如下接口引用：DescribeTopic

名称 必选 允许NULL 类型 描述
TopicId 是 否 String 主题的ID
TopicName 是 否 String 主题的名称
Note 是 是 String 备注

Tag

实例详情中的标签对象

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

名称 必选 允许NULL 类型 描述
TagKey 是 否 String 标签的key
TagValue 是 否 String 标签的值

TopicAttributesResponse

主题属性返回结果实体

被如下接口引用：DescribeTopicAttributes

名称 必选 允许NULL 类型 描述
TopicId 是 否 String 主题 ID
CreateTime 是 否 Int64 创建时间
Note 是 是 String 主题备注
PartitionNum 是 否 Int64 分区个数
EnableWhiteList 是 否 Int64 IP 白名单开关，1：打开； 0：关闭
IpWhiteList 是 否 Array of String IP 白名单列表
Config 是 否 Config topic 配置数组
Partitions 是 否 Array of TopicPartitionDO 分区详情

ConnectorStatus

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

被如下接口引用：DescribeConnectorStatus

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

GroupResponse

DescribeGroup的返回

被如下接口引用：DescribeGroup

名称 必选 允许NULL 类型 描述
TotalCount 是 是 Int64 计数
GroupList 是 是 Array of DescribeGroup GroupList

Partition

分区实体

被如下接口引用：DescribeConsumerGroup

名称 必选 允许NULL 类型 描述
PartitionId 是 否 Int64 分区ID

CreateInstancePreResponse

创建预付费实例返回结构

被如下接口引用：

名称 必选 允许NULL 类型 描述
ReturnCode 是 否 String 返回的code，0为正常，非0为错误
ReturnMessage 是 否 String 成功消息
Data 是 是 CreateInstancePreData 操作型返回的Data数据

GoodsInfo

后付费商品入参信息

被如下接口引用：HourCreate、HourModify

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

GroupInfoMember

consumer信息

被如下接口引用：DescribeGroupInfo

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

GroupOffsetTopic

消费分组主题对象

被如下接口引用：DescribeGroupOffsets

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

Price

消息价格实体

被如下接口引用：DescribeCkafkaZone

名称 必选 允许NULL 类型 描述
RealTotalCost 否 否 Float 折扣价
TotalCost 否 否 Float 原价

RouteResponse

路由信息返回对象

被如下接口引用：DescribeRoute

名称 必选 允许NULL 类型 描述
Routers 是 是 Array of Route 路由信息列表

ConnectorResponse

Connector返回结果对象

被如下接口引用：DescribeConnector

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

TaskStatusResponse

任务状态返回对象

被如下接口引用：DescribeTaskStatus

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

Acl

ACL对象实体

被如下接口引用：DescribeACL

名称 必选 允许NULL 类型 描述
ResourceType 是 否 Int64 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 是 否 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)
PermissionType 是 否 Int64 权限类型(0:UNKNOWN，1:ANY，2:DENY，3:ALLOW)

TopicResult

统一返回的TopicResponse

被如下接口引用：DescribeTopic

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

InstanceConfigDO

实例配置实体

被如下接口引用：DescribeInstanceAttributes

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

Region

地域实体对象

被如下接口引用：

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

TopicDetail

主题详情

被如下接口引用：DescribeTopicDetail

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

ClusterInfo

集群信息实体

被如下接口引用：DescribeCkafkaZone

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

Config

高级配置对象

被如下接口引用：DescribeTopicAttributes、DescribeTopicDetail

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

PartitionOffset

分区和位移

被如下接口引用：DescribeConsumerGroup

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

GroupInfoResponse

GroupInfo返回数据的实体

被如下接口引用：DescribeGroupInfo

名称 必选 允许NULL 类型 描述
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 消费分组

InstanceAttributesResponse

实例属性返回结果对象

被如下接口引用：DescribeInstanceAttributes

名称 必选 允许NULL 类型 描述
InstanceId 是 否 String 实例ID
InstanceName 是 否 String 实例名称
VipList 是 否 Array of VipEntity 接入点 VIP 列表信息
Vip 是 否 String 虚拟IP
Vport 是 否 String 虚拟端口
Status 是 否 Int64 实例的状态。0：创建中，1：运行中，2：删除中
Bandwidth 是 否 Int64 实例带宽，单位：Mbps
DiskSize 是 否 Int64 实例的存储大小，单位：GB
ZoneId 是 否 Int64 可用区
VpcId 是 否 String VPC 的 ID，为空表示是基础网络
SubnetId 是 否 String 子网 ID， 为空表示基础网络
Healthy 是 否 Int64 实例健康状态， 1：健康，2：告警，3：异常
HealthyMessage 是 否 String 实例健康信息，当前会展示磁盘利用率，最大长度为256
CreateTime 是 否 Uint64 创建时间
MsgRetentionTime 是 否 Int64 消息保存时间,单位为分钟
Config 是 否 InstanceConfigDO 自动创建 Topic 配置， 若该字段为空，则表示未开启自动创建
RemainderPartitions 是 否 Int64 剩余创建分区数
RemainderTopics 是 否 Int64 剩余创建主题数
CreatedPartitions 是 否 Int64 当前创建分区数
CreatedTopics 是 否 Int64 当前创建主题数
Tags 是 是 Array of Tag 标签数组
ExpireTime 是 是 Uint64 过期时间
ZoneIds 是 是 Array of Int64 跨可用区
Version 是 是 String kafka版本信息
MaxGroupNum 是 是 Int64 最大分组数
Cvm 是 是 Int64 售卖类型
CpuArch 否 否 Int64 集群的 CPU 架构。1:x86; 2:arm; 按位标记架构类型，例：3 二进制为 0011，表示 x86、arm 混合架构
ClusterId 否 是 Int64 实例所在集群的Id
ClusterName 否 是 String 实例所在集群的名称
PayMode 否 否 Int64 付费模式。-1:非付费实例(默认)；0:后付费实例；1:预付费实例

InstanceTypeConfigDO

实例规格配置对象

被如下接口引用：DescribeCkafkaTypeConfigs

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

GroupOffsetPartition

组偏移量分区对象

被如下接口引用：DescribeGroupOffsets

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

TopicPartitionDO

分区详情

被如下接口引用：DescribeTopicAttributes

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