数据结构

最近更新时间:2020-10-28 08:06:26

AutoScalingGroupRange

集群关联的伸缩组最大实例数最小值实例数

被如下接口引用:ModifyClusterAsGroupAttribute。

名称 类型 必选 描述
MinSize Integer 伸缩组最小实例数
MaxSize Integer 伸缩组最大实例数

AutoscalingAdded

自动扩所容的节点

被如下接口引用:DescribeClusterNodePoolDetail, DescribeClusterNodePools。

名称 类型 描述
Joining Integer 正在加入中的节点数量
Initializing Integer 初始化中的节点数量
Normal Integer 正常的节点数量
Total Integer 节点总数

Cluster

集群信息结构体

被如下接口引用:DescribeClusters。

名称 类型 描述
ClusterId String 集群ID
ClusterName String 集群名称
ClusterDescription String 集群描述
ClusterVersion String 集群版本(默认值为1.10.5)
ClusterOs String 集群系统。centos7.2x86_64 或者 ubuntu16.04.1 LTSx86_64,默认取值为ubuntu16.04.1 LTSx86_64
ClusterType String 集群类型,托管集群:MANAGED_CLUSTER,独立集群:INDEPENDENT_CLUSTER。
ClusterNetworkSettings ClusterNetworkSettings 集群网络相关参数
ClusterNodeNum Integer 集群当前node数量
ProjectId Integer 集群所属的项目ID
TagSpecification Array of TagSpecification 标签描述列表。
注意:此字段可能返回 null,表示取不到有效值。
ClusterStatus String 集群状态 (Running 运行中 Creating 创建中 Abnormal 异常 )
Property String 集群属性(包括集群不同属性的MAP,属性字段包括NodeNameType (lan-ip模式和hostname 模式,默认无lan-ip模式))
注意:此字段可能返回 null,表示取不到有效值。
ClusterMaterNodeNum Integer 集群当前master数量
ImageId String 集群使用镜像id
注意:此字段可能返回 null,表示取不到有效值。
OsCustomizeType String OsCustomizeType 系统定制类型
注意:此字段可能返回 null,表示取不到有效值。
ContainerRuntime String 集群运行环境docker或container
注意:此字段可能返回 null,表示取不到有效值。
CreatedTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
DeletionProtection Boolean 删除保护开关
注意:此字段可能返回 null,表示取不到有效值。

ClusterAdvancedSettings

集群高级配置

被如下接口引用:CreateCluster。

名称 类型 必选 描述
IPVS Boolean 是否启用IPVS
AsEnabled Boolean 是否启用集群节点自动扩缩容(创建集群流程不支持开启此功能)
ContainerRuntime String 集群使用的runtime类型,包括"docker"和"containerd"两种类型,默认为"docker"
NodeNameType String 集群中节点NodeName类型(包括 hostname,lan-ip两种形式,默认为lan-ip。如果开启了hostname模式,创建节点时需要设置HostName参数,并且InstanceName需要和HostName一致)
ExtraArgs ClusterExtraArgs 集群自定义参数
NetworkType String 集群网络类型(包括GR(全局路由)和VPC-CNI两种模式,默认为GR。
IsNonStaticIpMode Boolean 集群VPC-CNI模式是否为非固定IP,默认: FALSE 固定IP。
DeletionProtection Boolean 是否启用集群删除保护
KubeProxyMode String 集群的网络代理模型
AuditEnabled Boolean 是否开启审计开关
AuditLogsetId String 审计日志上传到的logset日志集
AuditLogTopicId String 审计日志上传到的topic
VpcCniType String 区分单网卡多IP模式和独立网卡模式

ClusterAsGroup

集群关联的伸缩组信息

被如下接口引用:DescribeClusterAsGroups。

名称 类型 描述
AutoScalingGroupId String 伸缩组ID
Status String 伸缩组状态(开启 enabled 开启中 enabling 关闭 disabled 关闭中 disabling 更新中 updating 删除中 deleting 开启缩容中 scaleDownEnabling 关闭缩容中 scaleDownDisabling)
IsUnschedulable Boolean 节点是否设置成不可调度
注意:此字段可能返回 null,表示取不到有效值。
Labels Array of Label 伸缩组的label列表
注意:此字段可能返回 null,表示取不到有效值。
CreatedTime String 创建时间

ClusterAsGroupAttribute

集群伸缩组属性

被如下接口引用:ModifyClusterAsGroupAttribute。

名称 类型 必选 描述
AutoScalingGroupId String 伸缩组ID
AutoScalingGroupEnabled Boolean 是否开启
AutoScalingGroupRange AutoScalingGroupRange 伸缩组最大最小实例数

ClusterAsGroupOption

集群弹性伸缩配置

被如下接口引用:DescribeClusterAsGroupOption。

名称 类型 描述
IsScaleDownEnabled Boolean 是否开启缩容
注意:此字段可能返回 null,表示取不到有效值。
Expander String 多伸缩组情况下扩容选择算法(random 随机选择,most-pods 最多类型的Pod least-waste 最少的资源浪费,默认为random)
注意:此字段可能返回 null,表示取不到有效值。
MaxEmptyBulkDelete Integer 最大并发缩容数
注意:此字段可能返回 null,表示取不到有效值。
ScaleDownDelay Integer 集群扩容后多少分钟开始判断缩容(默认为10分钟)
注意:此字段可能返回 null,表示取不到有效值。
ScaleDownUnneededTime Integer 节点连续空闲多少分钟后被缩容(默认为 10分钟)
注意:此字段可能返回 null,表示取不到有效值。
ScaleDownUtilizationThreshold Integer 节点资源使用量低于多少(百分比)时认为空闲(默认: 50(百分比))
注意:此字段可能返回 null,表示取不到有效值。
SkipNodesWithLocalStorage Boolean 含有本地存储Pod的节点是否不缩容(默认: FALSE)
注意:此字段可能返回 null,表示取不到有效值。
SkipNodesWithSystemPods Boolean 含有kube-system namespace下非DaemonSet管理的Pod的节点是否不缩容 (默认: FALSE)
注意:此字段可能返回 null,表示取不到有效值。
IgnoreDaemonSetsUtilization Boolean 计算资源使用量时是否默认忽略DaemonSet的实例(默认值: False,不忽略)
注意:此字段可能返回 null,表示取不到有效值。
OkTotalUnreadyCount Integer CA做健康性判断的个数,默认3,即超过OkTotalUnreadyCount个数后,CA会进行健康性判断。
注意:此字段可能返回 null,表示取不到有效值。
MaxTotalUnreadyPercentage Integer 未就绪节点的最大百分比,此后CA会停止操作
注意:此字段可能返回 null,表示取不到有效值。
ScaleDownUnreadyTime Integer 表示未准备就绪的节点在有资格进行缩减之前应该停留多长时间
注意:此字段可能返回 null,表示取不到有效值。
UnregisteredNodeRemovalTime Integer CA删除未在Kubernetes中注册的节点之前等待的时间
注意:此字段可能返回 null,表示取不到有效值。

ClusterBasicSettings

描述集群的基本配置信息

被如下接口引用:CreateCluster。

名称 类型 必选 描述
ClusterOs String 集群系统。centos7.2x86_64 或者 ubuntu16.04.1 LTSx86_64,默认取值为ubuntu16.04.1 LTSx86_64
ClusterVersion String 集群版本,默认值为1.10.5
ClusterName String 集群名称
ClusterDescription String 集群描述
VpcId String 私有网络ID,形如vpc-xxx。创建托管空集群时必传。
ProjectId Integer 集群内新增资源所属项目ID。
TagSpecification Array of TagSpecification 标签描述列表。通过指定该参数可以同时绑定标签到相应的资源实例,当前仅支持绑定标签到集群实例。
OsCustomizeType String 容器的镜像版本,"DOCKER_CUSTOMIZE"(容器定制版),"GENERAL"(普通版本,默认值)
NeedWorkSecurityGroup Boolean 是否开启节点的默认安全组(默认: 否,Aphla特性)

ClusterCIDRSettings

集群容器网络相关参数

被如下接口引用:CreateCluster。

名称 类型 必选 描述
ClusterCIDR String 用于分配集群容器和服务 IP 的 CIDR,不得与 VPC CIDR 冲突,也不得与同 VPC 内其他集群 CIDR 冲突。且网段范围必须在内网网段内,例如:10.1.0.0/14, 192.168.0.1/18,172.16.0.0/16。
IgnoreClusterCIDRConflict Boolean 是否忽略 ClusterCIDR 冲突错误, 默认不忽略
MaxNodePodNum Integer 集群中每个Node上最大的Pod数量。取值范围4~256。不为2的幂值时会向上取最接近的2的幂值。
MaxClusterServiceNum Integer 集群最大的service数量。取值范围32~32768,不为2的幂值时会向上取最接近的2的幂值。
ServiceCIDR String 用于分配集群服务 IP 的 CIDR,不得与 VPC CIDR 冲突,也不得与同 VPC 内其他集群 CIDR 冲突。且网段范围必须在内网网段内,例如:10.1.0.0/14, 192.168.0.1/18,172.16.0.0/16。
EniSubnetIds Array of String VPC-CNI网络模式下,弹性网卡的子网Id。
ClaimExpiredSeconds Integer VPC-CNI网络模式下,弹性网卡IP的回收时间,取值范围[300,15768000)

ClusterExtraArgs

集群master自定义参数

被如下接口引用:CreateCluster。

名称 类型 必选 描述
KubeAPIServer Array of String kube-apiserver自定义参数,参数格式为["k1=v1", "k1=v2"], 例如["max-requests-inflight=500","feature-gates=PodShareProcessNamespace=true,DynamicKubeletConfig=true"]
注意:此字段可能返回 null,表示取不到有效值。
KubeControllerManager Array of String kube-controller-manager自定义参数
注意:此字段可能返回 null,表示取不到有效值。
KubeScheduler Array of String kube-scheduler自定义参数
注意:此字段可能返回 null,表示取不到有效值。

ClusterNetworkSettings

集群网络相关的参数

被如下接口引用:DescribeClusters。

名称 类型 必选 描述
ClusterCIDR String 用于分配集群容器和服务 IP 的 CIDR,不得与 VPC CIDR 冲突,也不得与同 VPC 内其他集群 CIDR 冲突
IgnoreClusterCIDRConflict Boolean 是否忽略 ClusterCIDR 冲突错误, 默认不忽略
MaxNodePodNum Integer 集群中每个Node上最大的Pod数量(默认为256)
MaxClusterServiceNum Integer 集群最大的service数量(默认为256)
Ipvs Boolean 是否启用IPVS(默认不开启)
VpcId String 集群的VPCID(如果创建空集群,为必传值,否则自动设置为和集群的节点保持一致)
Cni Boolean 网络插件是否启用CNI(默认开启)

DataDisk

描述了k8s节点数据盘相关配置与信息。

被如下接口引用:AddExistedInstances, CreateCluster, CreateClusterAsGroup, CreateClusterInstances, CreateClusterNodePool, DescribeClusterInstances。

名称 类型 描述
DiskType String 云盘类型
注意:此字段可能返回 null,表示取不到有效值。
FileSystem String 文件系统(ext3/ext4/xfs)
注意:此字段可能返回 null,表示取不到有效值。
DiskSize Integer 云盘大小(G)
注意:此字段可能返回 null,表示取不到有效值。
AutoFormatAndMount Boolean 是否自动化格式盘并挂载
注意:此字段可能返回 null,表示取不到有效值。
MountTarget String 挂载目录
注意:此字段可能返回 null,表示取不到有效值。

EnhancedService

描述了实例的增强服务启用情况与其设置,如云安全,云监控等实例 Agent

被如下接口引用:AddExistedInstances, CreateCluster。

名称 类型 必选 描述
SecurityService RunSecurityServiceEnabled 开启云安全服务。若不指定该参数,则默认开启云安全服务。
MonitorService RunMonitorServiceEnabled 开启云监控服务。若不指定该参数,则默认开启云监控服务。

ExistedInstance

已经存在的实例信息

被如下接口引用:DescribeExistedInstances。

名称 类型 描述
Usable Boolean 实例是否支持加入集群(TRUE 可以加入 FALSE 不能加入)。
注意:此字段可能返回 null,表示取不到有效值。
UnusableReason String 实例不支持加入的原因。
注意:此字段可能返回 null,表示取不到有效值。
AlreadyInCluster String 实例已经所在的集群ID。
注意:此字段可能返回 null,表示取不到有效值。
InstanceId String 实例ID形如:ins-xxxxxxxx。
InstanceName String 实例名称。
注意:此字段可能返回 null,表示取不到有效值。
PrivateIpAddresses Array of String 实例主网卡的内网IP列表。
注意:此字段可能返回 null,表示取不到有效值。
PublicIpAddresses Array of String 实例主网卡的公网IP列表。
注意:此字段可能返回 null,表示取不到有效值。
注意:此字段可能返回 null,表示取不到有效值。
CreatedTime String 创建时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。
注意:此字段可能返回 null,表示取不到有效值。
CPU Integer 实例的CPU核数,单位:核。
注意:此字段可能返回 null,表示取不到有效值。
Memory Integer 实例内存容量,单位:GB。
注意:此字段可能返回 null,表示取不到有效值。
OsName String 操作系统名称。
注意:此字段可能返回 null,表示取不到有效值。
InstanceType String 实例机型。
注意:此字段可能返回 null,表示取不到有效值。
AutoscalingGroupId String 伸缩组ID
注意:此字段可能返回 null,表示取不到有效值。
InstanceChargeType String 实例计费模式。取值范围: PREPAID:表示预付费,即包年包月 POSTPAID_BY_HOUR:表示后付费,即按量计费 CDHPAID:CDH付费,即只对CDH计费,不对CDH上的实例计费。
注意:此字段可能返回 null,表示取不到有效值。

ExistedInstancesForNode

不同角色的已存在节点配置参数

被如下接口引用:CreateCluster。

名称 类型 必选 描述
NodeRole String 节点角色,取值:MASTER_ETCD, WORKER。MASTER_ETCD只有在创建 INDEPENDENT_CLUSTER 独立集群时需要指定。MASTER_ETCD节点数量为3~7,建议为奇数。MASTER_ETCD最小配置为4C8G。
ExistedInstancesPara ExistedInstancesPara 已存在实例的重装参数
InstanceAdvancedSettingsOverride InstanceAdvancedSettings 节点高级设置,会覆盖集群级别设置的InstanceAdvancedSettings(当前只对节点自定义参数ExtraArgs生效)

ExistedInstancesPara

已存在实例的重装参数

被如下接口引用:CreateCluster。

名称 类型 必选 描述
InstanceIds Array of String 集群ID
InstanceAdvancedSettings InstanceAdvancedSettings 实例额外需要设置参数信息
EnhancedService EnhancedService 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数,则默认开启云监控、云安全服务。
LoginSettings LoginSettings 节点登录信息(目前仅支持使用Password或者单个KeyIds)
SecurityGroupIds Array of String 实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。若不指定该参数,则绑定默认安全组。
HostName String 重装系统时,可以指定修改实例的HostName(集群为HostName模式时,此参数必传,规则名称除不支持大写字符外与CVM创建实例接口HostName一致)

ExtensionAddon

创建集群时,选择安装的扩展组件的信息

被如下接口引用:CreateCluster。

名称 类型 必选 描述
AddonName String 扩展组件名称
AddonParam String 扩展组件信息(扩展组件资源对象的json字符串描述)

Filter

描述键值对过滤器,用于条件过滤查询。例如过滤ID、名称、状态等

  • 若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。
  • 若同一个Filter存在多个Values,同一FilterValues间的关系为逻辑或(OR)关系。

DescribeInstances接口的Filter为例。若我们需要查询可用区(zone)为广州一区 并且 实例计费模式(instance-charge-type)为包年包月 或者 按量计费的实例时,可如下实现:

Filters.0.Name=zone
&Filters.0.Values.0=ap-guangzhou-1
&Filters.1.Name=instance-charge-type
&Filters.1.Values.0=PREPAID
&Filters.1.Values.1=POSTPAID_BY_HOUR

被如下接口引用:DescribeClusterRoutes, DescribeClusters, DescribeExistedInstances。

名称 类型 必选 描述
Name String 需要过滤的字段。
Values Array of String 字段的过滤值。

ImageInstance

镜像信息

被如下接口引用:DescribeImages。

名称 类型 描述
Alias String 镜像别名
注意:此字段可能返回 null,表示取不到有效值。
OsName String 操作系统名称
注意:此字段可能返回 null,表示取不到有效值。
ImageId String 镜像ID
注意:此字段可能返回 null,表示取不到有效值。
OsCustomizeType String 容器的镜像版本,"DOCKER_CUSTOMIZE"(容器定制版),"GENERAL"(普通版本,默认值)
注意:此字段可能返回 null,表示取不到有效值。

Instance

集群的实例信息

被如下接口引用:DescribeClusterInstances。

名称 类型 描述
InstanceId String 实例ID
InstanceRole String 节点角色, MASTER, WORKER, ETCD, MASTER_ETCD,ALL, 默认为WORKER
FailedReason String 实例异常(或者处于初始化中)的原因
InstanceState String 实例的状态(running 运行中,initializing 初始化中,failed 异常)
DrainStatus String 实例是否封锁状态
注意:此字段可能返回 null,表示取不到有效值。
InstanceAdvancedSettings InstanceAdvancedSettings 节点配置
注意:此字段可能返回 null,表示取不到有效值。
CreatedTime String 添加时间
LanIP String 节点内网IP
注意:此字段可能返回 null,表示取不到有效值。
NodePoolId String 资源池ID
注意:此字段可能返回 null,表示取不到有效值。
AutoscalingGroupId String 自动伸缩组ID
注意:此字段可能返回 null,表示取不到有效值。

InstanceAdvancedSettings

描述了k8s集群相关配置与信息。

被如下接口引用:AddExistedInstances, CreateCluster, CreateClusterAsGroup, CreateClusterInstances, CreateClusterNodePool, DescribeClusterInstances。

名称 类型 描述
MountTarget String 数据盘挂载点, 默认不挂载数据盘. 已格式化的 ext3,ext4,xfs 文件系统的数据盘将直接挂载,其他文件系统或未格式化的数据盘将自动格式化为ext4 并挂载,请注意备份数据! 无数据盘或有多块数据盘的云主机此设置不生效。
注意,注意,多盘场景请使用下方的DataDisks数据结构,设置对应的云盘类型、云盘大小、挂载路径、是否格式化等信息。
注意:此字段可能返回 null,表示取不到有效值。
DockerGraphPath String dockerd --graph 指定值, 默认为 /var/lib/docker
注意:此字段可能返回 null,表示取不到有效值。
UserScript String base64 编码的用户脚本, 此脚本会在 k8s 组件运行后执行, 需要用户保证脚本的可重入及重试逻辑, 脚本及其生成的日志文件可在节点的 /data/ccs_userscript/ 路径查看, 如果要求节点需要在进行初始化完成后才可加入调度, 可配合 unschedulable 参数使用, 在 userScript 最后初始化完成后, 添加 kubectl uncordon nodename --kubeconfig=/root/.kube/config 命令使节点加入调度
注意:此字段可能返回 null,表示取不到有效值。
Unschedulable Integer 设置加入的节点是否参与调度,默认值为0,表示参与调度;非0表示不参与调度, 待节点初始化完成之后, 可执行kubectl uncordon nodename使node加入调度.
Labels Array of Label 节点Label数组
注意:此字段可能返回 null,表示取不到有效值。
DataDisks Array of DataDisk 多盘数据盘挂载信息,同时请确保购买CVM的参数传递了购买多个数据盘的信息,如添加节点CreateClusterInstances API的RunInstancesPara下的DataDisks也设置了购买多个数据盘, 具体可以参考CreateClusterInstances接口的,添加集群节点(多块数据盘)样例
注意:此字段可能返回 null,表示取不到有效值。
ExtraArgs InstanceExtraArgs 节点相关的自定义参数信息
注意:此字段可能返回 null,表示取不到有效值。

InstanceDataDiskMountSetting

CVM实例数据盘挂载配置

被如下接口引用:CreateCluster。

名称 类型 必选 描述
InstanceType String CVM实例类型
DataDisks Array of DataDisk 数据盘挂载信息
Zone String CVM实例所属可用区

InstanceExtraArgs

节点自定义参数

被如下接口引用:AddExistedInstances, CreateCluster, CreateClusterAsGroup, CreateClusterInstances, CreateClusterNodePool, DescribeClusterInstances。

名称 类型 必选 描述
Kubelet Array of String kubelet自定义参数,参数格式为["k1=v1", "k1=v2"], 例如["root-dir=/var/lib/kubelet","feature-gates=PodShareProcessNamespace=true,DynamicKubeletConfig=true"]
注意:此字段可能返回 null,表示取不到有效值。

Label

k8s中标签,一般以数组的方式存在

被如下接口引用:AddExistedInstances, CreateCluster, CreateClusterAsGroup, CreateClusterInstances, CreateClusterNodePool, DescribeClusterAsGroups, DescribeClusterInstances, DescribeClusterNodePoolDetail, DescribeClusterNodePools, ModifyClusterNodePool。

名称 类型 必选 描述
Name String map表中的Name
Value String map表中的Value

LoginSettings

描述了实例登录相关配置与信息。

被如下接口引用:AddExistedInstances, CreateCluster。

名称 类型 必选 描述
Password String 实例登录密码。不同操作系统类型密码复杂度限制不一样,具体如下:
  • Linux实例密码必须8到30位,至少包括两项[a-z],[A-Z]、[0-9] 和 [( ) ` ~ ! @ # $ % ^ & - + = | { } [ ] : ; ' , . ? / ]中的特殊符号。
  • Windows实例密码必须12到30位,至少包括三项[a-z],[A-Z],[0-9] 和 [( ) ` ~ ! @ # $ % ^ & - + = | { } [ ] : ; ' , . ? /]中的特殊符号。

    若不指定该参数,则由系统随机生成密码,并通过站内信方式通知到用户。
    注意:此字段可能返回 null,表示取不到有效值。
  • KeyIds Array of String 密钥ID列表。关联密钥后,就可以通过对应的私钥来访问实例;KeyId可通过接口DescribeKeyPairs获取,密钥与密码不能同时指定,同时Windows操作系统不支持指定密钥。当前仅支持购买的时候指定一个密钥。
    注意:此字段可能返回 null,表示取不到有效值。
    KeepImageLogin String 保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为TRUE。取值范围:
  • TRUE:表示保持镜像的登录设置
  • FALSE:表示不保持镜像的登录设置

    默认取值:FALSE。
    注意:此字段可能返回 null,表示取不到有效值。
  • ManuallyAdded

    手动加入的节点

    被如下接口引用:DescribeClusterNodePoolDetail, DescribeClusterNodePools。

    名称 类型 描述
    Joining Integer 加入中节的点数量
    Initializing Integer 初始化中的节点数量
    Normal Integer 正常的节点数量
    Total Integer 节点总数

    NodeCountSummary

    节点统计列表

    被如下接口引用:DescribeClusterNodePoolDetail, DescribeClusterNodePools。

    名称 类型 描述
    ManuallyAdded ManuallyAdded 手动管理的节点
    注意:此字段可能返回 null,表示取不到有效值。
    AutoscalingAdded AutoscalingAdded 自动管理的节点
    注意:此字段可能返回 null,表示取不到有效值。

    NodePool

    节点池描述

    被如下接口引用:DescribeClusterNodePoolDetail, DescribeClusterNodePools。

    名称 类型 描述
    NodePoolId String NodePoolId 资源池id
    Name String Name 资源池名称
    ClusterInstanceId String ClusterInstanceId 集群实例id
    LifeState String LifeState 状态
    LaunchConfigurationId String LaunchConfigurationId 配置
    AutoscalingGroupId String AutoscalingGroupId 分组id
    Labels Array of Label Labels 标签
    Taints Array of Taint Taints 污点标记
    NodeCountSummary NodeCountSummary NodeCountSummary 节点列表
    AutoscalingGroupStatus String 状态信息
    注意:此字段可能返回 null,表示取不到有效值。
    MaxNodesNum Integer 最大节点数量
    注意:此字段可能返回 null,表示取不到有效值。
    MinNodesNum Integer 最小节点数量
    注意:此字段可能返回 null,表示取不到有效值。
    DesiredNodesNum Integer 期望的节点数量
    注意:此字段可能返回 null,表示取不到有效值。

    RegionInstance

    地域属性信息

    被如下接口引用:DescribeRegions。

    名称 类型 描述
    RegionName String 地域名称
    注意:此字段可能返回 null,表示取不到有效值。
    RegionId Integer 地域ID
    注意:此字段可能返回 null,表示取不到有效值。
    Status String 地域状态
    注意:此字段可能返回 null,表示取不到有效值。
    FeatureGates String 地域特性开关(按照JSON的形式返回所有属性)
    注意:此字段可能返回 null,表示取不到有效值。
    Alias String 地域简称
    注意:此字段可能返回 null,表示取不到有效值。
    Remark String 地域白名单
    注意:此字段可能返回 null,表示取不到有效值。

    ResourceDeleteOption

    资源删除选项

    被如下接口引用:DeleteCluster。

    名称 类型 必选 描述
    ResourceType String 资源类型,例如CBS
    DeleteMode String 集群删除时资源的删除模式:terminate(销毁),retain (保留)

    RouteInfo

    集群路由对象

    被如下接口引用:DescribeClusterRoutes。

    名称 类型 描述
    RouteTableName String 路由表名称。
    DestinationCidrBlock String 目的端CIDR。
    GatewayIp String 下一跳地址。

    RouteTableConflict

    路由表冲突对象

    被如下接口引用:DescribeRouteTableConflicts。

    名称 类型 描述
    RouteTableType String 路由表类型。
    RouteTableCidrBlock String 路由表CIDR。
    注意:此字段可能返回 null,表示取不到有效值。
    RouteTableName String 路由表名称。
    注意:此字段可能返回 null,表示取不到有效值。
    RouteTableId String 路由表ID。
    注意:此字段可能返回 null,表示取不到有效值。

    RouteTableInfo

    集群路由表对象

    被如下接口引用:DescribeClusterRouteTables。

    名称 类型 描述
    RouteTableName String 路由表名称。
    RouteTableCidrBlock String 路由表CIDR。
    VpcId String VPC实例ID。

    RunInstancesForNode

    不同角色的节点配置参数

    被如下接口引用:CreateCluster。

    名称 类型 必选 描述
    NodeRole String 节点角色,取值:MASTER_ETCD, WORKER。MASTER_ETCD只有在创建 INDEPENDENT_CLUSTER 独立集群时需要指定。MASTER_ETCD节点数量为3~7,建议为奇数。MASTER_ETCD节点最小配置为4C8G。
    RunInstancesPara Array of String CVM创建透传参数,json化字符串格式,详见CVM创建实例接口,传入公共参数外的其他参数即可,其中ImageId会替换为TKE集群OS对应的镜像。
    InstanceAdvancedSettingsOverrides Array of InstanceAdvancedSettings 节点高级设置,该参数会覆盖集群级别设置的InstanceAdvancedSettings,和上边的RunInstancesPara按照顺序一一对应(当前只对节点自定义参数ExtraArgs生效)。

    RunMonitorServiceEnabled

    描述了 “云监控” 服务相关的信息

    被如下接口引用:AddExistedInstances, CreateCluster。

    名称 类型 必选 描述
    Enabled Boolean 是否开启云监控服务。取值范围:
  • TRUE:表示开启云监控服务
  • FALSE:表示不开启云监控服务

    默认取值:TRUE。
  • RunSecurityServiceEnabled

    描述了 “云安全” 服务相关的信息

    被如下接口引用:AddExistedInstances, CreateCluster。

    名称 类型 必选 描述
    Enabled Boolean 是否开启云安全服务。取值范围:
  • TRUE:表示开启云安全服务
  • FALSE:表示不开启云安全服务

    默认取值:TRUE。
  • Tag

    标签绑定的资源类型,当前支持类型:"cluster"

    被如下接口引用:CreateCluster, DescribeClusters。

    名称 类型 必选 描述
    Key String 标签键
    Value String 标签值

    TagSpecification

    标签描述列表。通过指定该参数可以同时绑定标签到相应的资源实例,当前仅支持绑定标签到云主机实例。

    被如下接口引用:CreateCluster, DescribeClusters。

    名称 类型 必选 描述
    ResourceType String 标签绑定的资源类型,当前支持类型:"cluster"
    注意:此字段可能返回 null,表示取不到有效值。
    Tags Array of Tag 标签对列表
    注意:此字段可能返回 null,表示取不到有效值。

    Taint

    kubernetes Taint

    被如下接口引用:CreateClusterNodePool, DescribeClusterNodePoolDetail, DescribeClusterNodePools, ModifyClusterNodePool。

    名称 类型 必选 描述
    Key String Key
    Value String Value
    Effect String Effect
    目录