数据类型
Model 定义
InstanceGroupConfig
| 参数名 |
参数类型 |
是否必需 |
参数描述 |
| id |
String |
否 |
节点组 ID,节点组变更时必填 |
| name |
String |
否 |
节点组名称 |
| type |
String |
否 |
节点组类型(MASTER/CORE/TASK/CLIENT/MASTER_EXTEND) |
| instanceCount |
Int |
是 |
实例数量 |
| instanceType |
String |
是 |
实例类型 |
| rootDiskSizeInGB |
Int |
是 |
系统盘大小(GB) |
| rootDiskMediumType |
String |
是 |
系统盘介质类型 |
| cds |
List<CdsItem> |
否 |
CDS 数据盘列表,非本地 SSD 机型必需 |
| selectService |
Map<String,List<String> |
否 |
节点选装服务,仅新增节点组且在 type 为 MASTER-EXTEND 节点类型下填写 |
| shrinkInstanceIds |
List<String> |
否 |
释放的实例 Id,仅缩容节点组时生效 |
CdsItem
数据盘配置项。
| 参数名 |
参数类型 |
是否必需 |
参数描述 |
| sizeInGB |
Int |
是 |
磁盘大小(GB) |
| mediumType |
String |
是 |
云磁盘类型 |
| attributes |
List<String> |
否 |
磁盘属性 |
AutoScalingConfig
| 参数名 |
参数类型 |
是否必需 |
参数描述 |
| type |
String |
是 |
实例规格 |
| cpuCore |
Int |
是 |
CPU 核数 |
| memoryInGB |
Int |
是 |
内存(GB) |
| rootDiskSizeInGB |
Int |
否 |
系统盘(根盘)大小(GB) |
| rootMediumType |
String |
否 |
系统盘(根盘)介质类型 |
| cds |
List<CdsItem> |
否 |
数据盘配置列表(至少一个数据盘) |
| localDiskCount |
Int |
否 |
本地盘数量 |
| localDiskType |
String |
否 |
本地盘类型 |
| localDiskSizeInGB |
Int |
否 |
本地盘单盘大小(GB) |
AutoScalingSummary
弹性伸缩组配置概览。
| 参数名 |
参数类型 |
参数描述 |
| clusterId |
String |
集群 ID |
| clusterName |
String |
集群名 |
| status |
String |
弹性伸缩状态 |
| capacity |
Int |
当前最大实例数目 |
| maxCapacity |
Int |
可配置最大实例数目 |
| trickPolicy |
String |
关联策略 ID |
| type |
String |
关联策略类型 |
| isSpot |
Boolean |
是否为竞价实例 |
| availabilityZone |
String |
可用区 |
| configurations |
List<AutoScalingConfig> |
实例组配置 |
AutoScalingPolicy
弹性伸缩规则。
| 参数名 |
参数类型 |
是否必需 |
参数描述 |
| policyId |
String |
否 |
规则 ID(响应字段,请求时不传) |
| policyName |
String |
是 |
规则名称 |
| policyAction |
String |
是 |
伸缩动作:expand(扩容)/ shrink(缩容) |
| policyStepNum |
Int |
是 |
伸缩步长(实例数) |
| policyEnable |
Boolean |
否 |
是否启用,默认为 false |
| tricking |
Boolean |
否 |
是否正在触发执行中(响应字段) |
| updateAt |
Time |
否 |
最近更新时间,UTC 时间,示例 2026-06-16T12:32:32Z(响应字段) |
| policyType |
String |
是 |
规则类型:timer(定时)/ monitor(监控指标) |
| timerExecutionPeriod |
String |
否 |
定时执行周期(policyType=timer 必填):once(单次执行)/ daily(每天执行) |
| timerExecutionTime |
Time |
否 |
定时执行时间(policyType=timer 必填),UTC 时间,示例 2026-06-17T13:23:48Z |
| monitorIndicator |
String |
否 |
监控指标(policyType=monitor 必填):YarnAppsPending / YarnMemoryPercentage / CpuUsagePercentage |
| monitorReference |
String |
否 |
监控参考对象:min / max / average |
| monitorAction |
String |
否 |
监控触发动作:biggerThan / smallerThan |
| monitorThreshold |
Int |
否 |
监控阈值,取值范围 [0, 100] |
| monitorAcquisitionCycle |
Int |
否 |
监控采集周期,单位为分钟,取值范围 [5, 20] |
CapacityQueueItem
| 参数名 |
参数类型 |
是否必需 |
参数描述 |
YARN 配置映射 |
| id |
Int |
否 |
队列 ID |
— |
| name |
String |
是 |
队列名 |
yarn.scheduler.capacity.<parent>.queues 中的子队列名 |
| fullQueueName |
String |
是 |
队列全路径名(如 root.default) |
配置 key 前缀 yarn.scheduler.capacity.<fullQueueName>.* |
| status |
String |
是 |
队列状态(RUNNING / STOPPED) |
yarn.scheduler.capacity.<queue>.state |
| parentId |
Int |
否 |
父队列 ID |
— |
| level |
Int |
否 |
队列层级 |
— |
| capacity |
Int |
否 |
容量占比(百分比),默认为 0 |
yarn.scheduler.capacity.<queue>.capacity |
| maxCapacity |
Int |
否 |
最大容量占比(百分比),默认为 0 |
yarn.scheduler.capacity.<queue>.maximum-capacity |
| userLimitFactor |
Float |
否 |
用户使用上限因子,为 0 时使用 yarn 默认值 |
yarn.scheduler.capacity.<queue>.user-limit-factor |
| minUserLimit |
Int |
否 |
单用户可用资源最小占比(百分比),为 0 时使用 yarn 默认值 |
yarn.scheduler.capacity.<queue>.minimum-user-limit-percent |
| maxAllocMb |
Int |
否 |
单容器最大可分配内存(MB),为 0 时使用 yarn 默认值 |
yarn.scheduler.capacity.<queue>.maximum-allocation-mb |
| maxAllocVcore |
Int |
否 |
单容器最大可分配 vcore 数,为 0 时使用 yarn 默认值 |
yarn.scheduler.capacity.<queue>.maximum-allocation-vcores |
| maxApplications |
Int |
否 |
队列最大可同时运行的应用数,为 0 时使用 yarn 默认值 |
yarn.scheduler.capacity.<queue>.maximum-applications |
| maxAmResource |
Int |
否 |
AM 资源占比(百分比),为 0 时使用 yarn 默认值 |
yarn.scheduler.capacity.<queue>.maximum-am-resource-percent(API 存 0-100,YARN 存 0.0-1.0) |
| allowedUsers |
List<String> |
否 |
允许提交作业的用户列表,参数未指定时,默认为所有用户,参数指定为空列表时,默认无权限 |
yarn.scheduler.capacity.<queue>.acl_submit_applications(逗号分隔,nil→"*",空→" ") |
| accessibleLabels |
List<LabelCapacity> |
否 |
可访问的标签及其在该标签上的容量配置 (yarn 默认标签的值为空字符串 "") |
yarn.scheduler.capacity.<queue>.accessible-node-labels(逗号分隔标签名列表) |
| defaultLabelExpression |
String |
否 |
默认标签表达式,必须是 accessibleLabels 中存在的标签,默认为 DEFAULT_PARTITION |
yarn.scheduler.capacity.<queue>.default-node-label-expression |
LabelCapacity
| 参数名 |
参数类型 |
是否必需 |
参数描述 |
YARN 配置映射 |
| labelName |
String |
是 |
标签名,yarn 默认标签的值为空字符串 "" |
yarn.scheduler.capacity.<queue>.accessible-node-labels 列表中的元素 |
| capacity |
Int |
否 |
该标签上的容量占比(百分比),默认为 0 |
yarn.scheduler.capacity.<queue>.accessible-node-labels.<labelName>.capacity |
| maxCapacity |
Int |
否 |
该标签上的最大容量占比(百分比),默认为 0 |
yarn.scheduler.capacity.<queue>.accessible-node-labels.<labelName>.maximum-capacity |
FairQueueItem
| 参数名 |
是否必需 |
参数类型 |
参数描述 |
YARN 配置映射 |
| id |
否 |
Int |
队列 ID |
— |
| createAt |
否 |
Time |
创建时间 |
— |
| name |
否 |
String |
队列名 |
— |
| fullQueueName |
是 |
String |
队列全路径名 |
配置 key 前缀 <fullQueueName>.*(fair-scheduler 配置类型) |
| schedulingPolicy |
是 |
String |
调度策略(fair / fifo / drf) |
<queue>.schedulingPolicy |
| weight |
否 |
Int |
权重,默认为 0 |
<queue>.weight |
| minResources |
否 |
String |
最小资源(如 1024 mb,1 vcores) |
<queue>.minResources |
| maxResources |
否 |
String |
最大资源(如 1024 mb,1 vcores) |
<queue>.maxResources |
| maxRunningApps |
否 |
Int |
最大运行应用数,<= 0 时使用 yarn 默认值 |
<queue>.maxRunningApps |
| maxAmShare |
否 |
Float |
AM 资源占比上限(百分比, 1~100),<= 0 时使用 yarn 默认值 |
<queue>.maxAMShare(API 存 0-100,YARN 存 0.0-1.0) |
| allowPreemptionFrom |
否 |
Boolean |
是否允许从该队列抢占,默认为 false |
<queue>.allowPreemptionFrom |
| fairSharePreemptionThreshold |
否 |
Float |
公平份额抢占阈值,<= 0 时使用 yarn 默认值 |
<queue>.fairSharePreemptionThreshold |
| fairSharePreemptionTimeout |
否 |
Int |
公平份额抢占超时(秒),<= 0 时使用 yarn 默认值 |
<queue>.fairSharePreemptionTimeout |
| minSharePreemptionTimeout |
否 |
Int |
最小份额抢占超时(秒),<= 0 时使用 yarn 默认值 |
<queue>.minSharePreemptionTimeout |
YarnLabelInfo
| 参数名 |
是否必需 |
参数类型 |
参数描述 |
| name |
是 |
String |
标签名,仅允许字母、数字、_、-,首字符为字母或数字,长度 ≤ 255 |
| isExclusive |
是 |
Boolean |
是否为独占标签(exclusive) |
| nodes |
是 |
List<String> |
绑定到该标签的节点列表(节点 ID 或主机名) |
| totalCpu |
否 |
Float |
节点 CPU 总核数,仅返回参数 |
| totalMemoryGB |
否 |
Float |
节点内存总量(GB),仅返回参数 |
| isDefaultPartition |
否 |
Boolean |
是否为默认分区,仅返回参数 |
YarnGlobalConf
| 参数名 |
是否必需 |
参数类型 |
参数描述 |
Yarn 配置映射 |
| clusterId |
是 |
String |
集群 id |
- |
| queueType |
是 |
String |
队列调度类型(capacity / fair) |
yarn.resourcemanager.scheduler.class |
| capacityResourceCalculator |
是 |
String |
资源计算器类型 |
yarn.scheduler.capacity.resource-calculator |
| capacityNodeLocalityDelay |
否 |
Int |
节点本地化延迟调度参数 |
yarn.scheduler.capacity.node-locality-delay |
| queueMappings |
否 |
String |
队列映射规则 |
yarn.scheduler.capacity.queue-mappings |
ClusterOperation
| 参数名 |
参数类型 |
参数描述 |
| orderId |
String |
订单 ID |
| operationId |
String |
操作 ID |
| opType |
String |
操作类型(如 NEW、RESIZE、TERMINATE 等) |
| status |
String |
操作状态(init / success / failed 等) |
| startTime |
Time |
开始时间,UTC 时间,示例 2026-06-16T12:32:32Z |
| spentTime |
Float |
耗时(分钟),仅当 status 为 success/failed 时返回 |
| operator |
String |
操作人 |
| cancelable |
Boolean |
是否可取消,仅当订单处于 init 状态且可取消时为 true |
| hint |
String |
提示信息 |
ActionRecord
| 参数名 |
参数类型 |
参数描述 |
| id |
String |
记录 ID |
| shortId |
String |
短 ID |
| action |
String |
操作类型(如 RestartService、StopService 等) |
| actionDesc |
String |
操作描述 |
| status |
String |
状态(success / fail / pending) |
| statusDesc |
String |
状态描述 |
| operatorUserId |
String |
操作人 ID |
| operatorUserName |
String |
操作人名称 |
| startTime |
Time |
开始时间,UTC 时间,示例 2026-06-16T12:32:32Z |
| spentTime |
Float |
耗时(秒) |
| description |
String |
描述/备注 |
AutoScalingLog
| 参数名 |
参数类型 |
参数描述 |
| policyId |
String |
规则 ID |
| policyName |
String |
规则名称 |
| executionConfiguration |
String |
执行配置(节点组类型名) |
| policyAction |
String |
伸缩动作(EXPAND / SHRINK) |
| policyStepNum |
Int |
伸缩步长(执行后实例数 - 执行前实例数) |
| policyType |
String |
规则类型(MONITOR / TIMER) |
| startTime |
Time |
开始时间 |
| endTime |
Time |
结束时间 |
| status |
String |
执行状态(Success / Failure 等) |
| instancesNumAfterExecution |
Int |
执行后实例数 |
| before_exec_instance_num |
Int |
执行前实例数 |
| timerExecutionPeriod |
String |
定时规则执行周期(policyType=TIMER 时有效) |
| timerExecutionTime |
Time |
定时规则执行时间(policyType=TIMER 时有效) |
| monitorIndicator |
String |
监控指标(policyType=MONITOR 时有效,如 CPU_UTILIZATION) |
| monitorReference |
String |
监控比较方式 |
| monitorAction |
String |
监控动作 |
| monitorThreshold |
Int |
监控阈值 |
| monitorAcquisitionCycle |
Int |
监控采集周期(秒) |
PriceResult
| 参数名 |
参数类型 |
参数描述 |
| price |
Float |
价格,预付费单位为 元/月;后付费单位为 元/分钟 |
| dayCount |
Int |
天数 |
| discount |
Int |
折扣 |
Service
| 参数名 |
参数类型 |
参数描述 |
| serviceName |
String |
服务名称 |
| status |
String |
服务状态:Normal / Partial / Abnormal |
| url |
String |
服务代理 URL |
Component
| 参数名 |
参数类型 |
参数描述 |
| componentName |
String |
组件名称 |
| runningNum |
Int |
运行中的实例数 |
| stoppedNum |
Int |
已停止的实例数 |
| totalNum |
Int |
实例总数 |
| start |
Boolean |
是否可启动 |
| stop |
Boolean |
是否可停止 |
| restart |
Boolean |
是否可重启 |
TopologyInstance
| 参数名 |
参数类型 |
参数描述 |
| componentName |
String |
组件名称 |
| status |
String |
进程运行状态描述(Running / Stopped 等) |
| instanceName |
String |
实例名称 |
| instanceId |
String |
实例 ID(节点 ID) |
| ip |
String |
实例内网 IP |
| url |
String |
组件访问 URL(仅部分组件返回,如 IMPALA_DAEMON、KUDU_TSERVER 等) |
| groupName |
String |
实例组类型(MASTER / CORE / TASK / CLIENT) |
ServiceConfigFile
| 参数名 |
参数类型 |
参数描述 |
| typeName |
String |
配置文件类型名 |
| contentType |
String |
内容类型:content(纯文本)/ json(结构化键值) |
| content |
String |
配置文件内容;contentType=content 时为原始文本,contentType=json 时为序列化后的 JSON 字符串 |
| pushed |
Boolean |
当前配置是否已下发生效 |
ConfigHistory
| 参数名 |
参数类型 |
参数描述 |
| id |
String |
配置历史记录 ID(新管控下复用为 hostGroup 字段) |
| typeName |
String |
配置文件类型名 |
| preVersion |
Int |
修改前版本号 |
| currentVersion |
Int |
修改后版本号 |
| operator |
String |
操作人 |
| modifyTime |
Time |
修改时间 |
| remark |
String |
备注 |
| configGroupName |
String |
配置组名称 |
ServiceConfigHistoryDetail
| 参数名 |
参数类型 |
参数描述 |
| contentType |
String |
内容类型 |
| preContent |
String |
修改前的配置内容 |
| currentContent |
String |
修改后的配置内容 |
| remark |
String |
备注 |
InstanceGroupInfo
| 字段 |
类型 |
描述 |
| id |
String |
节点组 ID |
| name |
String |
节点组名称 |
| type |
String |
节点组类型(Master / Core / Task / Client / Master_extend 等) |
| spec |
String |
实例规格名称 |
| cpu |
Int |
单实例 CPU 核数 |
| memory |
Int |
单实例内存(GB) |
| isSpot |
Boolean |
是否抢占式实例 |
| bidModel |
String |
抢占式实例出价模式 |
| bidPrice |
String |
抢占式实例出价 |
| cds |
List<CdsItem> |
CDS 数据盘列表 |
| diskType |
String |
磁盘类型 |
| localDiskSize |
Int |
本地盘单盘容量(GB) |
| localDiskCount |
Int |
本地盘数量 |
| rootDiskSizeInGB |
Int |
系统盘容量(GB) |
| rootDiskMediumType |
String |
系统盘介质类型 |
| requestedInstanceCount |
Int |
期望实例数 |
| totalInstanceCount |
Int |
实例总数 |
| runningInstanceCount |
Int |
运行中实例数 |
| maxCount |
Int |
节点组允许的最大实例数 |
| minCount |
Int |
节点组允许的最小实例数 |
| canExpand |
Int |
可扩容数量 |
| canShrink |
Int |
可缩容数量 |
| state |
String |
节点组状态 |
| code |
String |
状态变更 code |
| message |
String |
状态变更描述 |
| payType |
String |
计费类型(Prepay / Postpay) |
| bccInstanceType |
String |
BCC 实例类型 |
| ebcDiskInfo |
String |
EBC 磁盘信息 |
| instanceType |
InstanceType |
实例规格详细信息 |
| pageNo |
Int |
实例分页页码 |
| pageSize |
Int |
实例分页每页数量 |
| totalCount |
Int |
实例总数 |
| instances |
List<Instance> |
节点(实例)列表 |
InstanceType
实例规格详细信息。
| 字段 |
类型 |
描述 |
| name |
String |
实例规格名称 |
| cpu |
Int |
CPU 核数 |
| memory |
Int |
内存(GB) |
| disk |
Int |
磁盘总容量(GB) |
| diskType |
String |
磁盘类型 |
Instance
节点信息。
| 字段 |
类型 |
描述 |
| id |
String |
实例 ID |
| bccInstanceId |
String |
BCC 实例 ID |
| instanceName |
String |
实例完整域名 |
| status |
InstanceStatus |
实例状态 |
| managementIP |
String |
管理 IP(仅在需要时返回) |
| privateDnsName |
String |
内网 DNS 名称 |
| privateIpAddress |
String |
内网 IP |
| publicDnsName |
String |
公网 DNS 名称 |
| publicIpAddress |
String |
公网 IP |
| sshPort |
Int |
SSH 端口 |
| volumes |
Map<String,List<VolumeSpec> |
节点挂载的卷信息,按挂载点分组 |
InstanceStatus
实例状态信息。
| 字段 |
类型 |
描述 |
| state |
String |
状态值【实例状态】 |
| code |
String |
状态变更 code |
| message |
String |
状态变更描述 |
| creationDateTime |
Time |
实例创建时间 |
| endDateTime |
Time |
实例结束时间 |
VolumeSpec
卷信息。
| 字段 |
类型 |
描述 |
| id |
String |
卷 ID |
| sizeInGB |
Int |
容量(GB) |
| storageType |
String |
存储类型 |
| diskMountPoints |
Map<String,String> |
挂载点信息 |
| attributes |
List<String> |
挂载属性 |
InstanceGroupItem
节点组变配接口配置
| 字段 |
类型 |
是否必须 |
描述 |
| clusterId |
String |
是 |
集群 ID。集群须处于 Active 且非伸缩中状态,否则报操作禁止 |
| type |
String |
是 |
操作类型,区分具体变配操作:
newInstanceGroup — 新增节点组
scaleOut — 扩容 / 缩容释放(共用)
scaleUp — 变更节点规格
diskScaleUp — 磁盘变配。取其它值会返回 InvalidArguments |
| instanceGroups |
List<InstanceGroupConfig> |
是 |
待变更的节点组配置。处理后须至少有一个实例组发生变更,否则报错 |
LkrUserGroupItem
| 参数名 |
参数类型 |
是否必须 |
参数描述 |
| id |
String |
是 |
用户组 ID |
| userGroup |
String |
是 |
用户组名称 |
| extra |
String |
否 |
附加信息 |
LkrUserItem
| 参数名 |
参数类型 |
是否必须 |
参数描述 |
| id |
Int |
是 |
用户 ID |
| name |
String |
是 |
用户名 |
| extra |
String |
否 |
备注 |
Password
| 参数名 |
参数类型 |
是否必须 |
参数描述 |
| linux |
String |
是 |
Linux 登录密码,传输时需要使用加密 |
| kerberos |
String |
是 |
Kerberos 密码,传输时需要使用加密 |
| knox |
String |
是 |
Knox 密码,传输时需要使用加密 |
LkrUserItemDisplay
| 参数名 |
参数类型 |
参数描述 |
| id |
Int |
用户 ID |
| name |
String |
用户名 |
| description |
String |
用户描述 |
| status |
String |
用户状态(active/disable) |
| extra |
String |
备注 |
| canModify |
Boolean |
当前登录账号是否有权修改该用户 |
| canDownload |
Boolean |
当前登录账号是否有权下载该用户的凭证 |
| canDelete |
Boolean |
当前登录账号是否有权删除该用户 |
| password |
Password |
用户密码(linux / kerberos / knox),响应参数中该值为空 |
| userGroups |
List<LkrUserGroupItem> |
用户所属的用户组列表 |
LkrUserGroupItemDisplay
| 参数名 |
参数类型 |
参数描述 |
| id |
String |
用户组 ID |
| userGroup |
String |
用户组名称 |
| cluster_id |
String |
集群 ID |
| userCount |
Int |
组内用户数量 |
| users |
List<LkrUserItem> |
组内用户列表 |
| extra |
String |
附加信息/备注 |
| canModify |
Boolean |
当前登录账号是否有权修改该用户组 |
| canDelete |
Boolean |
当前登录账号是否有权删除该用户组(组内无用户时为 true) |
Application
| 参数名 |
参数类型 |
是否必须 |
参数描述 |
| name |
String |
是 |
组件名称,如 hive、spark2。参考集群版本 |
| version |
String |
否 |
组件版本,如 3.1.0。 |
| properties |
String |
否 |
组件参数,如元数据配置等,参考服务组件属性 |
Tag
| 参数名 |
参数类型 |
是否必须 |
参数描述 |
| tagKey |
String |
是 |
标签键 |
| tagValue |
String |
否 |
标签值 |
ClusterStatus
| 参数名 |
参数类型 |
参数描述 |
| state |
String |
【集群状态】 |
| message |
String |
状态附加信息 |
InstanceGroupSummary
| 参数名 |
参数类型 |
参数描述 |
| id |
String |
实例组 ID |
| type |
String |
实例组类型 |
| instanceType |
String |
实例规格 |
| instanceCount |
Int |
实例数量 |
ClusterSummary
| 参数名 |
参数类型 |
参数描述 |
| id |
String |
集群 ID |
| name |
String |
集群名称 |
| payType |
String |
付费类型 |
| status |
ClusterStatus |
状态信息 |
| imageType |
String |
集群类型 |
| imageVersion |
String |
集群版本 |
| expired |
Boolean |
是否过期 |
| enableAutoScale |
Boolean |
是否开启弹性伸缩 |
| createTime |
Time |
创建时间 |
| tags |
List<Tag> |
标签 |
| applications |
List<Application> |
组件列表 |
| hmsUrl |
String |
Hive Metastore 地址 |
| kafkaUrl |
String |
Kafka 地址 |
| logUri |
String |
日志 BOS 路径 |
| serviceHaEnabled |
Boolean |
是否服务高可用 |
| safeModeEnabled |
Boolean |
是否安全模式 |
ClusterDetail
| 参数名 |
参数类型 |
参数描述 |
| id |
String |
集群 ID |
| name |
String |
集群名称 |
| availabilityZone |
String |
可用区 |
| payType |
String |
付费类型 |
| status |
ClusterStatus |
状态信息 |
| orderId |
String |
订单 ID |
| imageType |
String |
集群类型 |
| imageVersion |
String |
集群版本 |
| applications |
List<Application> |
组件列表 |
| vpcId |
String |
VPC ID |
| subnetId |
String |
子网 ID |
| securityGroupId |
List<String> |
安全组列表 |
| serviceHaEnabled |
Boolean |
是否服务高可用 |
| safeModeEnabled |
Boolean |
是否安全模式 |
| enableAutoScale |
Boolean |
是否开启弹性伸缩 |
| autoTerminate |
Boolean |
是否自动释放 |
| quotaEnabled |
Boolean |
是否启用配额 |
| canOperate |
Boolean |
当前用户是否可操作 |
| hmsUrl |
String |
Hive Metastore 地址 |
| kafkaUrl |
String |
Kafka 地址 |
| ambariUrl |
String |
Ambari 地址 |
| yarnUrl |
String |
YARN 地址 |
| instanceGroups |
List<InstanceGroupSummary> |
实例组列表 |
PaymentMethod
| 参数名 |
参数类型 |
参数描述 |
| type |
String |
付款类型,当前仅支持代金券 coupon |
| values |
List<String> |
引用值,代金券 id |
BosConfig
| 参数名 |
参数类型 |
参数描述 |
| bos_bucket |
String |
bos bucket ,例 bos://my-bucket |
| access_key |
String |
可读写 bos 的 ak,加密传输 |
| secret_key |
String |
可读写 bos 的 sk,加密传输 |
枚举类型说明
云磁盘类型
| 编码 |
类型 |
| ssd |
高性能云磁盘 |
| premium_ssd |
通用型SSD盘 |
| enhanced_ssd_pl1 |
增强型SSD PL1 |
实例组类型
| 编码 |
描述 |
| Master |
主实例组 |
| Master_extend |
主实例扩展组 |
| Core |
核心实例组,适合存储 |
| Task |
任务实例组,适合扩展 |
| Client |
客户端实例组,适合扩展 |
| AutoScaling |
弹性伸缩实例组,适合扩展 |
集群状态
| 编码 |
描述 |
| Starting |
启动中 |
| Running |
运行中 |
| Resizing |
调整中 |
| Terminating |
释放中 |
| Terminated |
已释放 |
| TerminatedWithError |
已释放但有错误 |
| Suspending |
停服中 |
| Suspended |
已停服 |
| Resuming |
恢复中 |
实例状态
| 编码 |
描述 |
| Configuring |
配置中 |
| Running |
运行中 |
| Suspending |
挂起中 |
| Suspended |
已挂起 |
| Decommissioning |
服务退场中 |
| Decommissioned |
服务已退场 |
| Resuming |
恢复中 |
| Deleting |
释放中 |
| Terminated |
已释放 |
集群版本
| 集群类型 |
集群版本 |
必选组件 |
可选的组件列表 |
| hadoop |
3.7.4 |
hadoop-common(3.3.6), hdfs(3.3.6), yarn(3.3.6), mapreduce(3.3.6), zookeeper(3.8.4), prometheus(3.2.1) |
hive(3.1.3), tez(0.10.2), spark(3.5.5), flink(1.20.0), hudi(0.15.0), iceberg(1.6.1), delta(3.2.0), trino(468), hue(4.8.0), airflow(2.7.3), oozie(5.1.0), kyuubi(1.10.0), ranger(2.3.0), dolphinscheduler(3.2.0), paimon(1.0.0), flume(1.9.0), sqoop(1.4.7) |
| hadoop-bos |
3.7.4 |
hadoop-common(3.3.6), bos-hdfs(3.3.6), yarn(3.3.6), mapreduce(3.3.6), zookeeper(3.8.4), prometheus(3.2.1) |
hive(3.1.3), tez(0.10.2), spark(3.5.5), flink(1.20.0), hudi(0.15.0), iceberg(1.6.1), delta(3.2.0), trino(468), hue(4.8.0), airflow(2.7.3), oozie(5.1.0), kyuubi(1.10.0), ranger(2.3.0), dolphinscheduler(3.2.0), paimon(1.0.0), flume(1.9.0), sqoop(1.4.7) |
| hbase |
2.4.18 |
hadoop-common(3.3.6), hdfs(3.3.6), zookeeper(3.8.4), ldap(2.4.48), hbase(2.4.18) |
yarn(3.3.6), mapreduce(3.3.6), phoenix(5.2.1) |
| trino |
468 |
hadoop-common(3.2.3), hdfs(3.2.3), zookeeper(3.8.4), ldap(2.4.48), hive(3.1.3), trino(468) |
hudi(0.15.0) |
服务组件属性
主要用于配置服务组件的依赖元数据信息。元数据类型如下:
-
数据库元信息(hive/hue/ranger/oozie/dolphinscheduler/airflow)
- default: 集群自带 mysql 服务,非高可用,随集群生命周期创建&删除。
-
mysql: 外置 mysql 服务,需用户自行提供,并确保网络连通性,当前提供以下两类外置 mysql 服务依赖
- 百度云 RDS Mysql:百度云 Mysql 服务,推荐使用,需额外提供 RDS 实例 id,用户授权白名单、用户超级用户权限标识等信息,可自动创建数据库并授权
- 用户自建 Mysql:仅 Hive 支持使用,需用户自行创建数据库、确保用户读写权限
-
Redis(airflow)
- default:集群自带 redis 服务,非高可用,随集群生命周期创建&删除。
- external:百度云 Redis:推荐使用,需额外提供 Redis 实例 id,用户名,密码等信息
| 参数名 |
参数类型 |
是否必须 |
参数描述 |
| metastore |
String |
否 |
数据库元信息类型,default/mysql |
| databaseAutoCreate |
String |
否 |
true 表示由 bmr 自动创建,数据库名称为组件名_集群 id 前 12 位(非 hive 服务强制使用自动创建) false 表示使用指定的数据库(仅 hive 支持) |
| host |
String |
否 |
mysql服务器地址,若metastore选用mysql,则必须提供 |
| port |
String |
否 |
mysql服务器端口,若metastore选用mysql,则必须提供 |
| database |
String |
否 |
metastore使用的数据库名称,若为自动创建,则为空,否则需提供数据库名称 |
| userName |
String |
否 |
用于连接mysql服务器的用户名,若metastore选用mysql,则必须提供 |
| password |
String |
否 |
用于连接mysql服务器的密码,若metastore选用mysql,则必须提供 |
| userAuthHost |
String |
否 |
百度云 RDS Mysql 必需,用于自动授权,账号的授权主机信息,建议使用 %,需要与 RDS 配置一致;【RDS 实例】- 【账号管理】-【主机】 |
| superUserFlag |
String |
否 |
百度云 RDS Mysql 必需,用于自动授权,连接 mysql 服务的用户名是否为超级用户,如果是,则使用 super,否则使用 common【RDS 实例】- 【账号管理】-【账号类型】 |
| rdsInsanceId |
String |
否 |
百度云 RDS Mysql 必需,自动创建 rds 数据库等信息,rds 实例 id |
| redis |
String |
否 |
redis 元信息类型,default/external |
| redisInstanceId |
String |
否 |
百度云 Redis 必填,redis 实例 id |
| redisHost |
String |
否 |
百度云 Redis 必填,redis 服务域名 |
| redisPort |
String |
否 |
百度云 Redis 必填, redis 服务端口 |
| redisUser |
String |
否 |
默认为 default |
| redisPassword |
String |
否 |
默认为空字符串 |