附录
更新时间：2025-08-21
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<String> | 集群所在的可用区列表 |
| payment | String | 集群的付费方式，可选的值为：Prepaid（预付费）和 Postpaid（后付费） |
| aclEnabled | Boolean | 集群是否开启权限控制 |
| publicIpEnabled | Boolean | 集群是否开启外网 |
| intranetIpEnabled | Boolean | 集群是否开启产品间转储 |
| authenticationModes | List<String> | 集群所使用的认证方式，可选的值为：Node（无需身份认证）、SASL_SCRAM（使用SASL/SCRAM机制进行身份认证）、SASL_PLAIN（使用SASL/PLAIN机制进行身份认证）、SSL（使用SSL证书双向认证） |
| 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<String> | 可用区列表 |
| vpc | Vpc | VPC信息，具体可参见Vpc，用于集群展示 |
| subnets | List<Subnet> | 子网列表，具体可参见Subnet ，用于集群展示 |
| securityGroups | List<SecurityGroup> | 安全组信息，具体可参见SecurityGroup ，用于集群展示 |
| vpcId | String | vpc短Id，仅用于创建集群的请求 |
| subnetIds | List<String> | 子网短Id列表，仅用于创建集群的请求 |
| securityGroupIds | List<String> | 安全组Id列表，仅用于创建集群的请求 |
| publicIpEnabled | boolean | 公网访问开关 |
| publicIpBandwidth | int | 公网访问带宽，限制为1~200的整数 |
| intranetIpEnabled | boolean | 产品间转储开关 |
| aclEnabled | boolean | 权限管理开关 |
| authentications | List<Authentication> | 集群所使用的认证方式列表，参见 Authentication |
| numberOfBrokerNodes | int | 集群节点总数 |
| numberOfBrokerNodesPerZone | int | 集群单分区节点数 |
| nodeType | String | 节点类型，如kafka.g4.c2m8 |
| storageMeta | StorageMeta | 存储信息，具体可参见StorageMeta |
| storagePolicyEnabled | Boolean | 是否开启磁盘水位处理 |
| storagePolicy | StoragePolicy | 磁盘阈值策略，具体可参见 StoragePolicy |
| 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 |
| vpcUuid | String | VPC的UUID，仅用于展示 |
| name | String | VPC的名称 |
| cidr | String | VPC的CIDR值 |
Subnet
| 参数名称 | 类型 | 描述 |
|---|---|---|
| subnetId | String | 子网 ID |
| subnetUuid | String | 子网 UUID，仅用于展示 |
| name | String | 子网名称 |
| subnetType | String | 子网类型 |
| zone | String | 区域 |
| vpcId | String | VPC的ID |
| cidr | String | CIDR值 |
SecurityGroup
| 参数名称 | 类型 | 描述 |
|---|---|---|
| securityGroupId | String | 安全组ID |
| securityGroupUuid | String | 安全组的UUID，仅用于展示 |
| name | String | 安全组名称 |
| vpcId | String | VPC的ID |
| vpcUuid | String | VPC的UUID，仅用于展示 |
StorageMeta
| 参数名称 | 类型 | 描述 |
|---|---|---|
| storageType | String | 存储类型 |
| storageSize | int | 存储大小 |
| numberOfDisk | int | 磁盘数量 |
StoragePolicy
| 参数名称 | 类型 | 描述 |
|---|---|---|
| type | StoragePolicyType | 存储策略类型，具体可参见：StoragePolicyType |
| autoDelete | AutoDelete | 自动删除策略相关参数，具体可参见：AutoDelete |
AutoDelete
| 参数名称 | 类型 | 描述 |
|---|---|---|
| diskUsedThresholdPercent | Integer | 磁盘容量阈值，达到该阈值后集群会按比例删除该磁盘上所有主题分区部分最早的消息 |
| logMinRetentionMs | Long | 主题分区最小保留时长，单位 ms |
| logMinRetentionBytes | Long | 主题分区最小保留大小，单位 byte |
ConfigMeta
| 参数名称 | 类型 | 描述 |
|---|---|---|
| configId | String | 集群配置ID |
| revisionId | String | 配置版本ID |
| context | Map<String, String> | 默认配置下的单独指定的键值对 |
Authentication
| 参数名称 | 类型 | 描述 |
|---|---|---|
| mode | String | 认证模式，可选的值为：Node（无需身份认证）、SASL_SCRAM（使用SASL/SCRAM机制进行身份认证）、SASL_PLAIN（使用SASL/PLAIN机制进行身份认证）、SSL（使用SSL证书双向认证） |
| 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，如果显示“-”则说明当前分区此时没有被消费者消费 |
| clientId | String | 正在消费当前分区的客户端ID |
| host | String | 正在消费当前分区的客户端IP |
| 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 |
ClusterConfig
| 参数名称 | 类型 | 描述 |
|---|---|---|
| configId | String | 配置ID |
| name | String | 配置名称 |
| state | String | 配置的状态，USED表示正在被集群使用，UNUSED表示没有集群使用 |
| description | String | 配置的描述信息 |
| createTime | String | 配置的创建时间，符合日期与时间规范的格式，例如：2023-05-10T03:06:01Z |
ClusterConfigRevision
| 参数名称 | 类型 | 描述 |
|---|---|---|
| revisionId | String | 配置版本ID |
| state | String | 配置版本的状态，USED表示正在被集群使用，UNUSED表示没有集群使用 |
| description | String | 配置版本的描述信息 |
| createTime | String | 配置版本的创建时间，符合日期与时间规范的格式，例如：2023-05-10T03:06:01Z |
ClusterConfigRevisionDetail
| 参数名称 | 类型 | 描述 |
|---|---|---|
| revisionId | String | 配置版本ID |
| state | String | 配置版本的状态，USED表示正在被集群使用，UNUSED表示没有集群使用 |
| description | String | 配置版本的描述信息 |
| createTime | String | 配置版本的创建时间，符合日期与时间规范的格式，例如：2023-05-10T03:06:01Z |
| context | List<TopicConfigOption> | 配置版本中具体的参数信息 |
ClusterConfigOption
| 参数名称 | 类型 | 描述 |
|---|---|---|
| name | String | 参数名称，参数介绍可参见：配置参数介绍 |
| description | String | 参数对应的描述 |
| updateMode | String | 参数的更新模式。STATIC表示静态参数，更新时需要重启集群，DYNAMIC表示动态参数，更新时不需要重启集群 |
| scope | Object[] | 参数对应的范围，如果参数的类型是INT、LONG等范围，则该值类似于[1, 168]，表示最小值为1，最大值为168；如果参数的类型是ENUM、BOOLEAN，则其中每一个元素表示可选的值，类似于[delete, compact] |
| defaultValue | Object | 参数的默认值 |
| currentValue | Object | 参数的当前值 |
| type | String | 参数的类型，例如：BOOLEAN、INT、LONG、ENUM |
| unit | String | 参数的单位，例如：ms、byte |
| category | String | 参数的分类，例如：主题、消费组 |
| overrideMode | String | 该参数是否必选。REQUIRED表示该参数在集群中必须进行配置，OPTIONAL表示可选 |
OperationGroup
| 参数名称 | 类型 | 描述 |
|---|---|---|
| groupName | String | 任务所属分组的类型名称，具体可选类型参见OperationGroupType |
| state | OperationState | 任务所属分组的执行状态，具体可选状态参见OperationState |
Job
| 参数名称 | 类型 | 描述 |
|---|---|---|
| jobId | String | 任务ID |
| name | JobType | 任务的类型，具体可选类型参见JobType |
| status | JobStatus | 任务的状态，具体可选状态参见JobStatus |
| operations | List<Operation> | 任务包含的操作列表，操作内容见Operation |
Operation
| 参数名称 | 类型 | 描述 |
|---|---|---|
| jobId | String | 任务ID |
| name | JobType | 任务的类型，具体可选类型参见JobType |
| status | JobStatus | 任务的状态，具体可选状态参见JobStatus |
| operationId | String | 操作ID |
| type | OperationType | 任务的类型，具体可选类型参见OperationType |
| state | OperationState | 任务的状态，具体可选状态参见OperationState |
| process | int | 任务执行的进度百分比值，取值范围为0到100 |
| schedule | String | 调度状态，字段可选：EXECUTE/SUSPEND, 分别代表执行中和挂起中 |
| started | boolean | 任务是否已经启动 |
| createTime | String | 任务创建的时间，符合日期与时间规范的格式，例如：2023-05-10T03:06:01Z |
| startTime | String | 任务开始启动的时间，符合日期与时间规范的格式，例如：2023-05-10T03:06:01Z |
| endTime | String | 任务结束的时间，符合日期与时间规范的格式，例如：2023-05-10T03:06:01Z |
OperationDetail
| 参数名称 | 类型 | 描述 |
|---|---|---|
| JobId | String | 任务ID |
| type | OperationType | 任务的类型，具体可选类型参见OperationType |
| operationId | String | 操作ID |
| state | OperationState | 任务的状态，具体可选状态参见OperationState |
| process | int | 任务执行的进度百分比值，取值范围为0到100 |
| schedule | String | 调度状态，字段可选：EXECUTE/SUSPEND, 分别代表执行中和挂起中 |
| started | boolean | 任务是否已经启动 |
| 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 | 目标更改内容 |
类型编码定义
StorageType
| 编码 | 描述 |
|---|---|
| ENHANCED_SSD_PL1 | 增强型SSD磁盘类型 |
| SSD | 高性能云磁盘 |
AclPatternType
| 编码 | 描述 |
|---|---|
| LITERAL | 精确匹配 |
| PREFIXED | 前缀匹配 |
AclResourceType
| 编码 | 描述 |
|---|---|
| TOPIC | 主题 |
| CLUSTER | 集群 |
| GROUP | 消费组 |
| TRANSACTIONAL_ID | 事务 |
AclOperationType
| 编码 | 描述 |
|---|---|
| PRODUCE | 发布 |
| CONSUME | 订阅 |
| IDEMPOTENT_WRITE | 幂等写 |
| WRITE | 写 |
JobType
| 编码 | 描述 |
|---|---|
| INCREASE_BROKER_COUNT | 增加节点数量 |
| DECREASE_BROKER_COUNT | 减少节点数量 |
| UPGRADE_BROKER_NODE_TYPE | 升级节点规格 |
| DOWNGRADE_BROKER_NODE_TYPE | 降低节点规格 |
| EXPAND_BROKER_DISK_CAPACITY | 扩容节点磁盘 |
| REASSIGN_PARTITION | 主题重新分区 |
| UPDATE_ACCESS_CONFIG | 变更集群访问 |
| RESTART_BROKER | 重启集群节点 |
| UPDATE_KAFKA_CONFIGURATION | 更新集群配置 |
| UPGRADE_KAFKA_VERSION | 升级集群版本 |
| SUSPEND_KAFKA_CLUSTER | 停止集群服务 |
| RESUME_KAFKA_CLUSTER | 启动集群服务 |
OperationType
| 编码 | 描述 |
|---|---|
| INCREASE_BROKER_COUNT | 扩容节点 |
| INCREASE_BROKER_COUNT_ROLLBACK | 回滚扩容 |
| DECREASE_BROKER_COUNT | 缩容节点 |
| DECREASE_BROKER_COUNT_ROLLBACK | 回滚缩容 |
| UPDATE_BROKER_NODE_TYPE | 变配节点 |
| UPDATE_BROKER_NODE_TYPE_ROLLBACK | 回滚变配 |
| EXPAND_BROKER_DISK_CAPACITY | 扩容磁盘 |
| EXPAND_BROKER_DISK_CAPACITY_ROLLBACK | 回滚扩容 |
| REASSIGN_PARTITION | 调整主题 |
| REASSIGN_PARTITION_ROLLBACK | 回滚调整 |
| UPDATE_ACCESS_CONFIG | 变更访问 |
| UPDATE_ACCESS_CONFIG_ROLLBACK | 回滚变更 |
| RESTART_KAFKA_CLUSTER | 重启集群 |
| RESTART_KAFKA_CLUSTER_ROLLBACK | 回滚重启 |
| RESTART_BROKER | 重启节点 |
| RESTART_BROKER_ROLLBACK | 回滚重启 |
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 | 空执行 |
StoragePolicyType
| 编码 | 描述 |
|---|---|
| AUTO_DELETE | 自动删除 |
状态编码定义
NodeServiceState
| 编码 | 描述 |
|---|---|
| NEW | 等待部署 |
| ALIVE | 服务中 |
| DEAD | 异常 |
| LOST | 丢失 |
ClusterState
| 编码 | 描述 |
|---|---|
| NEW | 新建 |
| DEPLOYING | 正在部署 |
| REBOOTING | 重启中 |
| ACTIVE | 服务中 |
| DEPLOY_FAILED | 部署失败 |
| UPDATING | 正在变更 |
| UPDATE_ROLLBACKING | 变更回滚中 |
| UPDATE_ROLLBACK_FAILED | 变更回滚失败 |
| SUSPENDED | 已停服 |
JobStatus
| 编码 | 描述 |
|---|---|
| NEW | 新建 |
| PENDING | 待执行 |
| RUNNING | 执行中 |
| SUSPENDED | 暂停 |
| CANCELLED | 取消 |
| FINISHED | 成功 |
| FAILED | 失败 |
OperationState
| 编码 | 描述 |
|---|---|
| NEW | 新建 |
| PENDING | 待执行 |
| RUNNING | 执行中 |
| SUSPENDED | 暂停 |
| CANCELLED | 取消 |
| FINISHED | 成功 |
| FAILED | 失败 |