You need to enable JavaScript to run this app.
导航

请求数据结构

最近更新时间2024.01.23 19:56:30

首次发布时间2022.06.27 21:21:52

本文主要描述容器服务 OpenAPI 的通用请求数据结构。

说明

本文通用请求参数中的非必选参数,无特殊说明的情况下,遵循以下规则:

  • 在调用创建资源(例如 CreateNodePool)的接口时,若不传入参数值,则使用默认值。
  • 在调用更新资源(例如 UpdateNodePoolConfig)的接口时,若不传入参数值,则保持原有的参数配置。

KubernetesConfigRequest

参数名参数类型是否必选示例值说明

Labels

Array of Label

-

节点池/节点的 Kubernetes 标签(Labels)信息。最多可传入 20 个标签。

说明

节点池会统一管理节点的标签配置信息,因此标签信息会同步到节点池内的所有节点上。当标签发生变更时,会覆盖原有的标签配置信息。

Taints

Array of Taint

-

节点池/节点的 Kubernetes 污点(Taints)信息。最多可传入 20 个污点。

说明

节点池会统一管理节点的污点配置信息,因此污点信息会同步到节点池内的所有节点上。当污点发生变更时,会覆盖原有的污点配置信息。

Cordon

Boolean

false

封锁节点配置,取值:

  • false:(默认值)不封锁
  • true:封锁

说明

更新节点池(UpdateNodePoolConfig)时,若不传入参数值,则保持原有参数配置。

NamePrefix

String

name-prefix

Kubernetes 中节点对象的元数据名称前缀。默认不启用,若设置表示启用,并将影响 Kubernetes Node Manifest 文件中展示的metadata.name前缀信息。前缀校验规则如下:

  • 支持英文小写字母、数字、中划线(-)和半角句号(.)。
  • 只能以英文小写字母或者数字开头。
  • 长度限制为 1~48 个字符。

NodePoolAutoScaling

参数名参数类型是否必选示例值说明

Enabled

Boolean

false

配置节点池弹性伸缩功能开关,取值:

  • false:(默认值)关闭。
  • true:开启。

MaxReplicas

Integer

10

配置节点池的最大节点数,取值说明:

  • 默认值:10
  • 取值范围:1~2000

注意

仅在节点池开启弹性伸缩功能后,对该节点池生效。

MinReplicas

Integer

0

配置节点池的最小节点数,取值说明:

  • 默认值:0
  • 最小值:0
  • 最大值:小于 MaxReplicas 参数的值

注意

仅在节点池开启弹性伸缩功能后,对该节点池生效。

DesiredReplicas

Integer

0

配置节点池的期望节点数,取值说明:

  • 默认值:0
  • 取值范围:0~2000

注意

节点池开启弹性伸缩功能时,DesiredReplicas 需大于等于 MinReplicas 参数的值,小于等于 MaxReplicas 参数的值。

Priority

Integer

10

优先级,取值说明:

  • 默认值:10
  • 取值范围:0~100

注意

仅针对节点池开启弹性伸缩功能且扩容算法为priority时生效。

SubnetPolicy

String

ZoneBalance

节点池的多子网调度策略,用于在 Worker 节点扩容时按照子网优先级顺序进行调度。取值:

  • ZoneBalance:(默认值)可用区均衡策略,节点扩容时,新增的节点会分散到多个可用区的子网下,且保证各个可用区中的节点数相对均衡。
  • Priority:子网优先级策略,按照子网列表的先后顺序调度。如果优先级最高的子网可以创建成功,则总在该子网下新增节点。

NodeLogin

参数名参数类型是否必选示例值说明

Password

String

UHdkMTIz****

Root 用户登录密码,使用 Base64 编码格式。
请遵循云服务器对于实例密码的要求规范:

  • 长度为 8~30 个字符
  • 不能以/$6$开头
  • 支持以下几项字符,且至少包含三项
    • 小写字母a~z
    • 大写字母A~Z
    • 数字0~9
    • 特殊字符( ) ` ~ ! @ # $ % ^ & * _ - + = | { } [ ] : ; ' < > , . ? /

SshKeyPairName

String

test-key

SSH 密钥对名称。
请确保该密钥对已在云服务器中创建或托管。

SystemVolume

参数名参数类型是否必选示例值说明

Type

String

ESSD_PL0

云盘类型:

  • ESSD_PL0:(默认值)性能级别为 PL0 的极速型 SSD 云盘。
  • ESSD_FlexPL:性能级别为 PL1 的极速型 SSD 云盘。
  • Ultra_Disk:高效型云盘。
  • PTSSD:性能型 SSD 云盘(即将下线该类型云盘,当前仅华北 2(北京)cn-beijing地域支持)。

注意

更新节点池时,该参数为必填参数,无默认值。

Size

Integer

40

云盘容量,单位 GiB,取值说明:

  • 默认值:40
  • 性能型 SSD(PTSSD):40~500
  • 极速型 SSD(ESSD_PL0,ESSD_FlexPL)、高效型云盘(Ultra_Disk):40~2048

注意

更新节点池时,该参数为必填参数,无默认值。

DataVolume

参数名参数类型是否必选示例值说明

Type

String

ESSD_PL0

磁盘类型:

  • ESSD_PL0:(默认值)性能级别为 PL0 的极速型 SSD 云盘。
  • ESSD_FlexPL:性能级别为 PL1 的极速型 SSD 云盘。
  • Ultra_Disk:高效型云盘。
  • PTSSD:性能型 SSD 云盘(即将下线该类型云盘,当前仅华北 2(北京)cn-beijing地域支持)。

注意

更新节点池时,该参数为必填参数,无默认值。

Size

Integer

20

磁盘容量,单位 GiB,数据云盘数值范围:

  • 默认值:20
  • 性能型 SSD(PTSSD):20~8192
  • 极速型 SSD(ESSD_PL0,ESSD_FlexPL):20~32768
  • 高效型云盘(Ultra_Disk):20~32768

注意

更新节点池时,该参数为必填参数,无默认值。

MountPoint

String

/vke

磁盘格式化后的目标挂载目录,取值要求如下:

  • 必须以/开头。
  • 长度限制为 1~255 个字符。
  • 不同数据盘的挂载目录不允许重复。

Label

参数名参数类型是否必选示例值说明

Key

String

lable-key/os

标签键,要求如下,更多规则,请参见 Kubernetes 标签规则
有效的标签键有两个段:<前缀>和<名称>,用斜杠(/)分隔。

  • <名称>是必须的,支持英文大小写字母、数字、短划线(-)、下划线(_)、英文句号( .),以字母或数字开头和结尾,长度不超过 63 个字符。
  • <前缀>是可选的。如果指定<前缀>,则必须是 DNS 子域:由英文句号(.)分隔的一系列 DNS 标签,长度不超过 253 个字符。
  • <前缀>和<名称>总长度不超过 82 个字符。

Value

String

linux

标签值,要求如下,更多规则,请参见 Kubernetes 标签规则

  • 长度不超过 63 个字符(可以为空)。
  • 支持以英文大小写字母、数字开头和结尾。
  • 支持特殊字符:短划线(-)、下划线(_)、英文句号(.)。

Taint

参数名参数类型是否必选示例值说明

Effect

String

NoSchedule

污点效果,取值:

  • NoSchedule:(默认值)不调度。
  • NoExecute:驱逐没有容忍污点的 Pod。
  • PreferNoSchedule:尽量避免调度。

Key

String

taint-key/node-type

污点键,要求如下,更多规则,请参见 Kubernetes 标签规则
有效的污点键有两个段:<前缀>和<名称>,用斜杠(/)分隔。

  • <名称>是必须的,支持英文大小写字母、数字、短划线(-)、下划线(_)、英文句号( .),以字母或数字开头和结尾,长度不超过 63 个字符。
  • <前缀>是可选的。如果指定<前缀>,则必须是 DNS 子域:由英文句号(.)分隔的一系列 DNS 标签,长度不超过 253 个字符。
  • <前缀>和<名称>总长度不超过 82 个字符。

Value

String

vci

污点值,要求如下,更多规则,请参见 Kubernetes 标签规则

  • 长度不超过 63 个字符(可以为空)。
  • 支持以英文大小写字母、数字开头和结尾。
  • 支持特殊字符:短划线(-)、下划线(_)、英文句号(.)。

Tag

参数名称类型是否必选示例值描述

Key

String

key

标签键。

  • 不能以任何大小写形式的volc:开头。
  • 只能包含语言字符、数字、空格和特殊符号_.:/=+-@
  • 长度限制为 1~128 个字符。

Value

String

value

标签值,可以为空。

  • 只能包含语言字符、数字、空格和特殊符号_.:/=+-@
  • 长度不超过 256 个字符。

ClusterLoggingConfigRequest

参数名称类型是否必选示例值描述

LogSetups

Array of
LogSetupRequest

-

集群的日志选项信息。

  • 空数组代表不开启任何日志。
  • 首次开启日志时,日志主题(Log Topic)自动生成。
  • 多个日志选项时,LogType 不允许重复。

LogProjectId

String

b68324a0-2680-48c7-a42e-8d78********

集群的日志项目(Log Project)ID。

注意

  • 不可以空字符串。
  • 创建集群时,若 LogProjectId 不传参数值,表示由系统自动创建新的日志项目。
  • 系统自动创建日志项目,按照k8s-log-{clusterId}-{6位随机字符}格式自动生成项目名称。
  • 如果 LogSetups.Enabled 字段取值为 false,则不会自动创建日志项目。
  • 更新集群配置时,若 LogProjectId 已指定日志项目,则不可更新为空。
  • 更新集群配置时,若集群不存在任何日志配置,此时只传了 LogProjectIdLogSetups 为空时,LogProjectId 将会被忽略。
  • 更新 LogProjectId 会为处于开启状态的日志创建新的主题。

LogSetupRequest

参数名称类型是否必选示例值描述

LogType

String

Audit

当前开启的日志类型,取值:

  • Audit:集群审计日志
  • KubeApiServer:kube-apiserver 组件日志
  • KubeScheduler:kube-scheduler 组件日志
  • KubeControllerManager:kube-controller-manager 组件日志

LogTtl

Integer

30

日志在日志服务中的保存时间,超过指定的日志存储时长后,此日志主题中的过期日志会被自动清除。

  • 取值范围:1~3650
  • 单位:天
  • 默认值:30 天
    指定为 3650 天表示永久存储。

Enabled

Boolean

false

是否开启该日志选项,取值:

  • false:(默认值)不开启
  • true:开启

注意

  • 更新集群配置时,若 LogTypeAudit,则更改 Enabled 会重启 Apiserver。
  • 更新集群配置时,若 Enabledfalse 更换为 true,则会创建新的日志主题。