ukafka

type AddUKafkaInstanceNodeRequest struct {
	request.CommonBase

	// 实例ID
	InstanceId *string `required:"true"`

	// 新添加节点数量
	NodeCount *int `required:"true"`

	// 机型，支持的机型可通过GetUKafkaNodeType 接口返回的InstanceTypeSet[].InstanceTypeName
	NodeType *string `required:"true"`
}

type AddUKafkaInstanceNodeResponse struct {
	response.CommonBase

	// 错误信息
	Message string
}

type Broker struct {

	// broker id
	BrokerId string

	// broker 关联topic 信息
	BrokerInfo []BrokerOfTopicInfo

	// broker 创建信息
	CreateTime string

	// broker 域名
	DomainName string

	// broker 访问端点
	Endpoints Endpoints

	// broker 过期时间
	ExpireTime int

	// broker IP 信息
	IPSet []IP

	// broker 机型信息
	InstanceGroupType string

	// kafka 服务端口
	KafkaPort int

	// broker 备注信息
	Remark string

	// broker 注册资源信息
	ResourceId string

	// 安全组 id
	SecurityGroupId string

	// broker 当前状态
	State string

	// broker 节点配置
	UHostConfig UHostConfig

	// 节点 id
	UHostId string

	// 节点名称
	UHostName string

	// 节点类型
	UHostRole string

	// 节点是否部署 zookeeper
	ZooKeeper string

	// zookeeper 服务端口
	ZooKeeperPort int
}

type BrokerOfTopicInfo struct {

	// topic 在 broker 上分布的 partition 数量
	PartitionOnBroker string

	// topic 在 broker上 partition 列表
	Partitions string

	// Topic 副本数
	Replication int

	// topic 名称
	TopicName string

	// partition 数量
	TotalPartitions int
}

type ClusterInfo struct {

	// 是否开启自动续费
	AutoRenew string

	// 业务组 ID
	BusinessId string

	// 付费类型
	ChargeType string

	// 实例id
	ClusterInstanceId string

	// 实例名称
	ClusterInstanceName string

	// 实例创建时间
	CreateTime int

	// 实例过期时间
	ExpireTime int

	// 实例框架
	Framework string

	// 实例框架版本
	FrameworkVersion string

	// 是否开启安全组
	IsOpenSecgroup string

	// 网络 id（已废弃）
	NetworkId string

	// 实例备注
	Remark string

	// 实例运行时间
	RunningTime int

	// 实例当前状态,实例状态："Running"| "Abnormal"| "Creating"| "Deleting"| "CreateFailed"| "DeleteFailed"| "Unavailable"| "Deleted"| "Updating"| "Deploying"| "Migrating"| "ExpandFailed"
	State string

	// 所属子网 id
	SubnetId string

	// 实例标记
	Tag string

	// 实例节点个数
	UHostCount int

	// 节点信息列表
	UHostSet []Broker

	// 所属 VPC id
	VPCId string

	// 可用节点个数
	ValidBrokerNum int

	// 所属可用区
	Zone string
}

type CreateUKafkaInstanceRequest struct {
	request.CommonBase

	// 业务组，默认Default
	BusinessId *string `required:"false"`

	// 付费方式
	ChargeType *string `required:"true"`

	// 磁盘管理方式,支持值：NONE、CLEAN。默认值：NONE
	DiskControllerType *string `required:"false"`

	// 数据盘大小。支持范围根据GetUKafkaNodeType 接口返回的InstanceTypeSet[].MaxDiskSize 和MinDiskSize获取
	DiskSize *int `required:"true"`

	// 磁盘清理阈值，支持范围[70,90]。DiskControllerType 为CLEAN 时必填。默认值 90
	DiskThreshold *string `required:"false"`

	// kafka版本，支持的版本可通过ListUKafkaFrameworkVersion 接口返回字段的FrameworkVersions获取
	FrameworkVersion *string `required:"true"`

	// 实例名，可自定义
	InstanceName *string `required:"true"`

	// 是否开启安全组，支持"true","false"，默认 false
	IsSecurityEnabled *string `required:"false"`

	// kafka 日志保存时间，支持范围[1,240]。默认 72 小时
	LogRetentionHours *string `required:"false"`

	// 集群节点数量。默认 3 节点
	NodeCount *int `required:"false"`

	// 机型，支持的机型可通过GetUKafkaNodeType 接口返回的InstanceTypeSet[].InstanceTypeName
	NodeType *string `required:"true"`

	// 实例数量，默认 1
	Quantity *string `required:"false"`

	// 子网 ID
	SubnetId *string `required:"true"`

	// VPCID
	VPCId *string `required:"true"`
}

type CreateUKafkaInstanceResponse struct {
	response.CommonBase

	// 实例资源 ID
	InstanceId string

	// 错误信息
	Message string
}

type DeleteUKafkaInstanceRequest struct {
	request.CommonBase

	// 实例ID
	InstanceId *string `required:"true"`
}

type DeleteUKafkaInstanceResponse struct {
	response.CommonBase

	// 错误信息
	Message string
}

type DescribeUKafkaConsumerRequest struct {
	request.CommonBase

	// Kafka 集群 ID
	ClusterInstanceId *string `required:"true"`

	// 消费组组名
	ConsumerGroup *string `required:"true"`

	// 消费者组类型（同消费者组列表返回的类型值）
	Type *string `required:"true"`
}

type DescribeUKafkaConsumerResponse struct {
	response.CommonBase

	// 消费者组组名
	GroupName string

	// 消费者组所订阅 topic 信息
	Topics string

	// 消费者组类型
	Type string
}

type DescribeUKafkaInstanceRequest struct {
	request.CommonBase

	// 实例ID，可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取
	ClusterInstanceId *string `required:"true"`
}

type DescribeUKafkaInstanceResponse struct {
	response.CommonBase

	// 集群信息列表
	ClusterSet []ClusterInfo
}

type DiskSet struct {

	// 磁盘大小
	Size string

	// 磁盘类型。Boot 表示系统盘，Data 表示数据盘
	Type string
}

type Endpoints struct {

	// PLAINTEXT 协议访问信息
	PlainText Url

	// SASL_PLAINTEXT 协议访问信息
	SaslPlainText Url
}

type GetUKafkaNodeTypeRequest struct {
	request.CommonBase

	// 传参时返回指定机型信息，参数为空时返回所有机型信息
	NodeType *string `required:"false"`
}

type GetUKafkaNodeTypeResponse struct {
	response.CommonBase

	// 错误信息
	Message string

	// 机型信息列表
	NodeTypeSet []InstanceType
}

type Group struct {

	// 消费者组组名
	GroupName string

	// 订阅 Topic 数量
	NumOfTopics int

	// 消费者组类型
	Type string
}

type IP struct {

	// IP地址
	IP string

	// IP类型
	Type string
}

type InstanceType struct {

	// CPU核心数
	CPU int

	// 机型磁盘类型信息
	DiskSet DiskSet

	// 磁盘类型。RSSD 表示固态云盘，SSD 表示本地固态盘，COMMON 表示本地 SATA 盘
	DiskType string

	// 内存大小（单位 MB）
	Memory string

	// 机型名称
	NodeTypeName string
}

type IsUKafkaTopicNameExistRequest struct {
	request.CommonBase

	// 集群ID
	ClusterInstanceId *string `required:"true"`

	// 待检查的topic名称
	TopicName *string `required:"true"`
}

type IsUKafkaTopicNameExistResponse struct {
	response.CommonBase

	// 是否已经存在
	IsExist string
}

type ListUKafkaConsumersRequest struct {
	request.CommonBase

	// Kafka 集群 ID
	ClusterInstanceId *string `required:"true"`
}

type ListUKafkaConsumersResponse struct {
	response.CommonBase

	// 消费者组列表
	Groups []Group
}

type ListUKafkaFrameworkVersionRequest struct {
	request.CommonBase
}

type ListUKafkaFrameworkVersionResponse struct {
	response.CommonBase

	// kafka版本
	FrameworkVersions []Version

	// 错误信息
	Message string
}

type ListUKafkaInstanceRequest struct {
	request.CommonBase

	// 业务组 ID
	BusinessId *string `required:"false"`

	// 实例ID
	ClusterInstanceId *string `required:"false"`

	// 是否过滤删除了的节点，默认为‘true’
	Filter *string `required:"false"`

	// 默认为60
	Limit *string `required:"false"`

	// 默认为0
	Offset *string `required:"false"`

	// SubnetId
	SubnetId *string `required:"false"`

	// VPCId
	VPCId *string `required:"false"`
}

type ListUKafkaInstanceResponse struct {
	response.CommonBase

	// 信息
	ClusterSet string

	// 错误信息
	Message string

	// 总数
	TotalCount string
}

type ListUKafkaTopicsRequest struct {
	request.CommonBase

	// 集群资源id
	ClusterInstanceId *string `required:"true"`
}

type ListUKafkaTopicsResponse struct {
	response.CommonBase

	// 列表长度
	Length int

	// topic 信息列表
	TopicList []TopicInfo
}

type ModifyUKafkaInstanceTypeRequest struct {
	request.CommonBase

	// 实例ID
	InstanceId *string `required:"true"`

	// 目标机型，支持的机型可通过GetUKafkaNodeType 接口返回的InstanceTypeSet[].InstanceTypeName
	NodeType *string `required:"true"`
}

type ModifyUKafkaInstanceTypeResponse struct {
	response.CommonBase

	// 错误信息
	Message string
}

type ResizeUKafkaDiskRequest struct {
	request.CommonBase

	// 数据盘大小。支持范围根据GetUKafkaNodeType 接口返回的InstanceTypeSet[].MaxDiskSize 和MinDiskSize获取
	DiskSize *int `required:"true"`

	// 实例ID
	InstanceId *string `required:"true"`
}

type ResizeUKafkaDiskResponse struct {
	response.CommonBase

	// 错误信息
	Message string
}

type TopicInfo struct {

	// 占用 broker 数量
	NumOfOccupyBroker int

	// 分区数量
	NumOfPartition int

	// 副本数量
	NumOfReplica int

	// topic 状态
	Status string

	// topic 名称
	Topic string

	// 落后副本占比
	UnderReplicasPer float64
}

type UHostConfig struct {

	// 节点系统盘大小（单位G)【删除】
	BootDiskSize int

	// 节点 CPU 核心数
	CPU int

	// 节点数据盘大小（单位G)
	DataDiskSize int

	// 节点数据盘类型
	DiskType string

	// 节点内存(单位MB)
	Memory int

	// 节点内部系统名称【删除】
	OS string
}

type UKafkaClient struct {
	*ucloud.Client
}

type Url struct {

	// 访问地址
	Addr string

	// 访问协议
	Protocal string
}

type Version struct {

	// kafka 版本标签。recommend 表示推荐版本，beta 表示公测版本
	Label string

	// kafka版本
	Version string
}