附录
更新时间:2023-07-05
Model对象定义
AccessEndpoint
参数名称 | 类型 | 描述 |
---|---|---|
securityProtocol | String | Kafka集群的接入点协议,不同的协议具有不同的使用场景: |
endpoints | String | Kafka集群对应当前访问协议的接入点地址 |
network | String | Kafka集群对应的网络环境,具体可选VPC,WAN |
Cluster
参数名称 | 类型 | 描述 |
---|---|---|
clusterId | String | 集群的ID |
clusterSid | String | 集群的短ID |
name | String | 集群的名称 |
region | String | 集群地域 |
type | String | 集群类型,具体值可为PROVISIONED,SERVERLESS |
mode | String | 集群模式,具体值可为HP、HA |
state | String | 集群状态,具体可参见ClusterState |
kafkaVersion | String | 集群的版本,当前仅支持2.7.2 |
logicalZones | List |
集群所在的可用区列表 |
payment | String | 集群的付费方式,可选的值为:Prepaid(预付费)和 Postpaid(后付费) |
aclEnabled | Boolean | 集群是否开启权限控制 |
publicIpEnabled | Boolean | 集群是否开启外网 |
intranetIpEnabled | Boolean | 集群是否开启vpc网卡 |
authenticationModes | List |
集群所使用的认证方式,可选的值为:Node(无需身份认证)、SASL_SCRAM(使用SASL/SCRAM机制进行身份认证) |
tags | List<Tag> | 集群所绑定的标签信息 |
createTime | String | 创建用户时的时间,符合日期与时间规范的格式,例如:2023-05-10T03:06:01Z |
expireTime | String | 集群的过期时间,当付费方式为后付费时,该值固定为-1 |
ClusterDetail
参数名称 | 类型 | 描述 |
---|---|---|
clusterId | String | 集群的ID |
clusterSid | String | 集群的短ID |
name | String | 集群的名称 |
region | String | 集群地域 |
type | String | 集群类型,具体值可为PROVISIONED,SERVERLESS |
mode | String | 集群模式,具体值可为HP、HA |
state | String | 集群状态,具体可参见ClusterState |
provisioned | Provisioned | provisioned type的集群上下文,具体参见Provisioned |
tags | List<Tag> | 集群所绑定的标签信息 |
createTime | String | 创建用户时的时间,符合日期与时间规范的格式,例如:2023-05-10T03:06:01Z |
Provisioned
参数名称 | 类型 | 描述 |
---|---|---|
kafkaVersion | String | 集群的版本,当前仅支持2.7.2 |
billing | Billing | billing对象,具体可参见Billing |
logicalZones | List |
可用区列表 |
vpc | Vpc | VPC信息,具体可参见Vpc,用于集群展示 |
subnets | List<Subnet> | 子网列表,具体可参见Subnet ,用于集群展示 |
securityGroup | SecurityGroup | 安全组信息,具体可参见SecurityGroup |
vpcId | String | vpc短Id,仅用于创建集群的请求 |
subnetIds | List |
子网短Id列表,仅用于创建集群的请求 |
publicIpEnabled | boolean | 公网访问开关 |
publicIpBandwidth | int | 公网访问带宽,限制为1~200的整数 |
intranetIpEnabled | boolean | vpc网卡开关 |
aclEnabled | boolean | 权限管理开关 |
authentications | List<Authentication> | 集群所使用的认证方式列表,参见 Authentication |
numberOfBrokerNodes | int | 集群节点总数 |
numberOfBrokerNodesPerZone | int | 集群单分区节点数 |
nodeType | String | 节点类型,如kafka.g4.c2m8 |
storageMeta | StorageMeta | 存储信息,具体可参见StorageMeta |
configMeta | ConfigMeta | 自定义配置模板的元信息,具体可参见ConfigMeta |
deploySetEnabled | boolean | 是否开启部署集 |
Billing
参数名称 | 类型 | 描述 |
---|---|---|
payment | String | 付费模式 |
timeLength | int | 预付费时长 |
timeUnit | String | 预付费时长单位 |
expireTime | String | 预付费到期时间, 用于展示 |
autoRenewEnabled | boolean | 自动续费开关 |
autoRenewTimeLength | int | 自动续费时长 |
autoRenewTimeUnit | String | 自动续费时长单位 |
couponIds | List |
有值时使用代金券,可以指定使用哪些代金券 |
isAutoPay | boolean | 是否自动支付,默认为true |
Vpc
参数名称 | 类型 | 描述 |
---|---|---|
vpcId | String | VPC的ID |
name | String | VPC的名称 |
cidr | String | VPC的CIDR值 |
Subnet
参数名称 | 类型 | 描述 |
---|---|---|
subnetId | String | 子网 ID |
name | String | 子网名称 |
subnetType | String | 子网类型 |
zone | String | 区域 |
vpcId | String | VPC的ID |
cidr | String | CIDR值 |
SecurityGroup
参数名称 | 类型 | 描述 |
---|---|---|
securityGroupId | String | 安全组ID |
name | String | 安全组名称 |
vpcId | String | VPC的ID |
StorageMeta
参数名称 | 类型 | 描述 |
---|---|---|
storageType | String | 存储类型 |
storageSize | int | 存储大小 |
numberOfDisk | int | 磁盘数量 |
ConfigMeta
参数名称 | 类型 | 描述 |
---|---|---|
configId | String | 配置模板ID |
revisionId | String | 修订ID |
context | Map<String, String> | 默认配置下的单独指定的键值对 |
Authentication
参数名称 | 类型 | 描述 |
---|---|---|
mode | String | 认证模式,可选的值为:NONE(无需身份认证)、SASL_SCRAM(使用SASL/SCRAM机制进行身份认证)等 |
context | String | 复杂对象,存放证书等 |
Node
参数名称 | 类型 | 描述 |
---|---|---|
brokerId | Int | 当前节点的序号,从1开始递增到节点个数 |
host | String | 节点的host |
nodeId | String | 节点的ID |
status | NodeState | 当前节点的状态,具体可选状态参见NodeState |
publicIp | String | 节点的公网地址,只有集群开启公网时才会有具体的值,否则为null |
internalIp | String | 节点的VPC地址 |
Acl
参数名称 | 类型 | 描述 |
---|---|---|
username | String | 用户名称 |
patternType | AclPatternType | 匹配模式 |
resourceType | String | 资源类型 |
resourceName | String | 资源名称 |
operation | List |
操作类型列表 |
Tag
参数名称 | 类型 | 描述 |
---|---|---|
tagKey | String | 标签的键,可包含大小写字母、数字、中文以及-_ /.特殊字符,长度1-65 |
tagValue | String | 标签的值,可包含大小写字母、数字、中文以及-_ /.特殊字符,长度0-65 |
Group
参数名称 | 类型 | 描述 |
---|---|---|
groupName | String | 消费组的名称 |
updateTime | String | 消费组最后一次消费的时间,符合日期与时间规范的格式,例如:2023-05-10T03:06:01Z |
User
参数名称 | 类型 | 描述 |
---|---|---|
username | String | 用户名称 |
createTime | String | 创建用户时的时间,符合日期与时间规范的格式,例如:2023-05-10T03:06:01Z |
TopicConfig
参数名称 | 类型 | 描述 |
---|---|---|
message.timestamp.type | String | 消息息时间戳类型,LogAppendTime、CreateTime,默认值:CreateTime |
cleanup.policy | String | 清理策略, compact、delete, 默认值: delete |
min.insync.replicas | String | 同步副本数, 最小为1,最大为主题的副本数,默认值:1 |
retention.ms | String | 消息保留时长,范围:1~1728000000,默认值:172800000 |
segment.ms | String | 日志分片时间, 范围:1~1048576000,默认值:604800000 |
max.message.bytes | String | 单条消息最大值, 范围:1~1048576000, 默认值: 1048588 |
GroupTopicPartition
参数名称 | 类型 | 描述 |
---|---|---|
partitionId | int | 消费者实例所订阅topic的具体分区ID |
topicName | String | 消费者实例所订阅的topic名称 |
consumerId | String | 正在消费当前分区的消费者实例ID,如果显示“-”则说明当前分区此时没有被消费者消费 |
maxOffset | long | 当前分区的最大位点 |
committedOffset | long | 当前消费者实例的消费位点 |
lag | long | 当前消费者实例在当前分区的消息堆积量,该值为maxOffset与committedOffset的差值 |
lastConsumeTime | String | 当前消费者最后消费的时间,符合日期与时间规范的格式,例如:2023-05-10T03:06:01Z |
Topic
参数名称 | 类型 | 描述 |
---|---|---|
topicName | String | topic的名称 |
createTime | String | 创建topic时的时间,符合日期与时间规范的格式,例如:2023-05-10T03:06:01Z |
TopicDetail
参数名称 | 类型 | 描述 |
---|---|---|
topicName | String | topic的名称 |
partitionNum | int | topic的分区数量 |
replicationFactor | int | topic的副本数量 |
brokersSkewed | double | broker 倾斜百分比 |
brokersLeaderSkewed | double | broker leader倾斜百分比 |
brokersSpread | double | broker覆盖率 |
preferredReplicas | double | Preferred Replicas % |
underReplicated | double | Under-replicated % |
otherConfigs | List<TopicConfig> | topic的高级配置内容 |
TopicPartition
参数名称 | 类型 | 描述 |
---|---|---|
topicName | String | 主题名称 |
partitionId | int | topic的分区ID |
leaderId | int | 当前分区leader副本所在的节点ID |
replicas | List |
当前分区副本所在节点ID列表 |
inSyncReplicas | List |
当前分区已同步副本所在节点ID列表 |
minOffset | long | 当前分区的最小位点 |
maxOffset | long | 当前分区的最大位点 |
messageNum | long | 当前分区拥有的消息总量 |
lastUpdateTime | String | 当前分区最近更新时间的时间,符合日期与时间规范的格式,例如:2023-05-10T03:06:01Z |
类型编码定义
StorageType
编码 | 描述 |
---|---|
ENHANCED_SSD_PL1 | 增强型SSD磁盘类型 |
SSD | 高性能云磁盘 |
AclPatternType
编码 | 描述 |
---|---|
LITERAL | 精确匹配 |
PREFIXED | 前缀匹配 |
AclResourceType
编码 | 描述 |
---|---|
TOPIC | 主题 |
CLUSTER | 集群 |
GROUP | 消费组 |
TRANSACTIONAL_ID | 事务 |
AclOperationType
编码 | 描述 |
---|---|
PRODUCE | 发布 |
CONSUME | 订阅 |
IDEMPOTENT_WRITE | 幂等写 |
WRITE | 写 |
状态编码定义
NodeServiceState
编码 | 描述 |
---|---|
NEW | 等待部署 |
ALIVE | 服务中 |
DEAD | 异常 |
LOST | 丢失 |
ClusterState
编码 | 描述 |
---|---|
NEW | 新建 |
DEPLOYING | 正在部署 |
REBOOTING | 重启中 |
ACTIVE | 服务中 |
DEPLOY_FAILED | 部署失败 |
UPDATING | 正在变更 |
UPDATE_ROLLBACKING | 变更回滚中 |
UPDATE_ROLLBACK_FAILED | 变更回滚失败 |
NodeState
编码 | 描述 |
---|---|
NEW | 等待部署 |
ALIVE | 服务中 |
DEAD | 异常 |
LOST | 丢失 |
JobType
编码 | 描述 |
---|---|
UPDATE_ACCESS_CONFIG | 变更访问配置 |
REASSIGN_PARTITION | 主题调整 |
RESTART_KAFKA_CLUSTER | 重启集群 |
RESTART_BROKER | 重启节点 |
EXPAND_BROKER_DISK_CAPACITY | 扩容磁盘 |
UPDATE_BROKER_NODE_TYPE | 变配节点 |
INCREASE_BROKER_COUNT | 新增节点 |
JobState
编码 | 描述 |
---|---|
NEW | 新建 |
PENDING | 待执行 |
RUNNING | 执行中 |
SUSPENDED | 暂停 |
CANCELLED | 取消 |
FINISHED | 成功 |
FAILED | 失败 |
OperationGroupType
编码 | 描述 |
---|---|
CHECK_BCC_RESOURCE_FOR_KAFKA | Kafka BCC资源余量检查 |
CHECK_CDS_RESOURCE_FOR_KAFKA | Kafka CDS资源余量检查 |
APPLY_DEPLOY_SET_RESOURCE | 部署集资源申请 |
APPLY_BCC_RESOURCE_FOR_KAFKA | Kafka BCC资源申请 |
APPLY_BCC_RESOURCE_FOR_ZOOKEEPER | ZooKeeper BCC资源申请 |
APPLY_EIP_RESOURCE_FOR_KAFKA | Kafka EIP资源申请 |
APPLY_CDS_RESOURCE_FOR_KAFKA | Kafka CDS资源申请 |
RESIZE_NODE_TYPE_RESOURCE_KAFKA | Kafka 节点类型变更 |
INIT_DEPLOY_ENVIRONMENT | 初始化部署环境 |
RESIZE_FS_CAPACITY_FOR_KAFKA | 扩容文件系统大小 |
CONFIG_KAFKA_SERVICE | 更新 Kafka 服务配置 |
START_KAFKA_SERVICE | 启动 Kafka 服务 |
RESTART_KAFKA_SERVICE | 重启 Kafka 服务 |
START_ZOOKEEPER_SERVICE | 启动 ZooKeeper 服务 |
UPDATE_METADATA_FOR_CLUSTER | 集群元数据信息更新 |
TOPIC_REASSIGN_PARTITION | 主题重分区 |
CANCEL_REASSIGN_PARTITION | 取消主题重分区 |
RELEASE_ALL_RESOURCE | 释放所有资源 |
NOTHING | 空执行 |
OperationGroup
参数名称 | 类型 | 描述 |
---|---|---|
groupName | String | 任务所属分组的类型名称,具体可选类型参见OperationGroupType |
state | JobState | 任务所属分组的执行状态,具体可选状态参见JobState |
Job
参数名称 | 类型 | 描述 |
---|---|---|
jobId | String | 任务ID |
type | JobType | 任务的类型,具体可选类型参见JobType |
state | JobState | 任务的状态,具体可选状态参见JobState |
process | int | 任务执行的进度百分比值,取值范围为0到100 |
createTime | String | 任务创建的时间,符合日期与时间规范的格式,例如:2023-05-10T03:06:01Z |
startTime | String | 任务开始启动的时间,符合日期与时间规范的格式,例如:2023-05-10T03:06:01Z |
endTime | String | 任务结束的时间,符合日期与时间规范的格式,例如:2023-05-10T03:06:01Z |
JobDetail
参数名称 | 类型 | 描述 |
---|---|---|
JobId | String | 任务ID |
type | JobType | 任务的类型,具体可选类型参见JobType |
state | JobState | 任务的状态,具体可选状态参见JobState |
process | int | 任务执行的进度百分比值,取值范围为0到100 |
createTime | String | 任务创建的时间,符合日期与时间规范的格式,例如:2023-05-10T03:06:01Z |
startTime | String | 任务开始启动的时间,符合日期与时间规范的格式,例如:2023-05-10T03:06:01Z |
endTime | String | 任务结束的时间,符合日期与时间规范的格式,例如:2023-05-10T03:06:01Z |
groups | List<OperationGroup> | 任务所属的分组信息列表 |
sourceContext | String | 原始内容 |
targetContext | String | 目标更改内容 |