Annotation
k8s中标注，一般以数组的方式存在
被如下接口引用：CreateNodePool, DescribeNodePools, ModifyNodePool。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 是 | map表中的Name 示例值：k8s-app |
| Value | String | 是 | map表中的Value 示例值：billing |
AutoUpgradeOptions
托管节点池运维窗口设置
被如下接口引用：CreateNodePool, ModifyNodePool。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| AutoUpgradeStartTime | String | 否 | 自动升级开始时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：24:00 |
| Duration | String | 否 | 自动升级持续时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：3h |
| WeeklyPeriod | Array of String | 否 | 运维日期 注意：此字段可能返回 null，表示取不到有效值。 示例值：["Monday"] |
AutoscalingAdded
自动扩缩容的节点
被如下接口引用：DescribeNodePools。
| 名称 | 类型 | 描述 |
|---|---|---|
| Joining | Integer | 正在加入中的节点数量 示例值：1 |
| Initializing | Integer | 初始化中的节点数量 示例值：1 |
| Normal | Integer | 正常的节点数量 示例值：1 |
| Total | Integer | 节点总数 示例值：1 |
Cluster
集群信息结构体
被如下接口引用：DescribeClusters。
| 名称 | 类型 | 描述 |
|---|---|---|
| ClusterId | String | 集群ID 示例值：cls-xxxxxxx |
| ClusterName | String | 集群名称 示例值：集群 |
| ClusterDescription | String | 集群描述 示例值：示例集群 |
| ClusterVersion | String | 集群版本（默认值为1.10.5） 示例值：1.20.6 |
| ClusterType | String | 集群类型，托管集群：MANAGED_CLUSTER，独立集群：INDEPENDENT_CLUSTER。 示例值：INDEPENDENT_CLUSTER |
| TagSpecification | Array of TagSpecification | 标签描述列表。 注意：此字段可能返回 null，表示取不到有效值。 |
| ClusterStatus | String | 集群状态 (Trading 集群开通中,Creating 创建中,Running 运行中,Deleting 删除中,Idling 闲置中,Recovering 唤醒中,Upgrading 升级中,NodeUpgrading 节点升级中,RuntimeUpgrading 节点运行时升级中,MasterScaling Master扩缩容中,ClusterLevelUpgrading 调整规格中,ResourceIsolate 欠费隔离中,ResourceIsolated 欠费已隔离,ResourceReverse 冲正恢复中,Abnormal 异常) 示例值：Running |
| CreatedTime | String | 创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2021-06-16T07:42:57Z |
| ClusterLevel | String | 集群等级，针对托管集群生效 注意：此字段可能返回 null，表示取不到有效值。 注意：此字段可能返回 null，表示取不到有效值。 示例值：L5 |
| VpcId | String | 集群所在vpc的id 注意：此字段可能返回 null，表示取不到有效值。 示例值：vpc-xxx |
CreateNativeNodePoolParam
原生节点池创建参数
被如下接口引用：CreateNodePool。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Scaling | MachineSetScaling | 是 | 节点池伸缩配置 |
| SubnetIds | Array of String | 是 | 子网列表 示例值：["subnet-4h43fuxj"] |
| InstanceChargeType | String | 是 | 节点计费类型。PREPAID：包年包月；POSTPAID_BY_HOUR：按量计费（默认）； 示例值：PREPAID |
| SystemDisk | Disk | 是 | 系统盘配置 |
| InstanceTypes | Array of String | 是 | 机型列表 示例值：["S2.SMALL2"] |
| SecurityGroupIds | Array of String | 否 | 安全组列表 示例值：["sg-4h43fuxj"] |
| UpgradeSettings | MachineUpgradeSettings | 否 | 自动升级配置 |
| AutoRepair | Boolean | 否 | 是否开启自愈能力 示例值：true |
| InstanceChargePrepaid | InstanceChargePrepaid | 否 | 包年包月机型计费配置 |
| Management | ManagementConfig | 否 | 节点池 Management 参数设置 |
| HealthCheckPolicyName | String | 否 | 故障自愈规则名称 示例值：policy1 |
| HostNamePattern | String | 否 | 原生节点池hostName模式串 示例值：aaa{R:3} |
| KubeletArgs | Array of String | 否 | kubelet 自定义参数 示例值：["kube-api-qps=50"] |
| Lifecycle | LifecycleConfig | 否 | 预定义脚本 |
| RuntimeRootDir | String | 否 | 运行时根目录 示例值：/var/lib/docker |
| EnableAutoscaling | Boolean | 否 | 是否开启弹性伸缩 示例值：true |
| Replicas | Integer | 否 | 期望节点数 示例值：10 |
| InternetAccessible | InternetAccessible | 否 | 公网带宽设置 |
| DataDisks | Array of DataDisk | 否 | 原生节点池数据盘列表 |
| QGPUEnable | Boolean | 否 | qgpu开关 示例值：true |
| KeyIds | Array of String | 否 | 节点池ssh公钥id数组 示例值：["sky-6esd9xe","sky-shjixw8"] |
| MachineType | String | 否 | 节点池类型 示例值：NativeCVM或者Native |
| AutomationService | Boolean | 否 | 原生节点池安装节点自动化助手开关 示例值：false |
| Password | String | 否 | 原生节点池密码 示例值：Paas@123 |
DataDisk
描述了k8s节点数据盘相关配置与信息。
被如下接口引用：CreateNodePool, DescribeClusterInstances, DescribeNodePools, ModifyNodePool。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DiskType | String | 是 | 云盘类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：CLOUD_PREMIUM |
| FileSystem | String | 是 | 文件系统(ext3/ext4/xfs) 注意：此字段可能返回 null，表示取不到有效值。 示例值：ext4 |
| DiskSize | Integer | 是 | 云盘大小(G） 注意：此字段可能返回 null，表示取不到有效值。 示例值：50 |
| AutoFormatAndMount | Boolean | 是 | 是否自动化格式盘并挂载 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| DiskPartition | String | 是 | 挂载设备名或分区名 注意：此字段可能返回 null，表示取不到有效值。 示例值：/dev/vdb |
| MountTarget | String | 否 | 挂载目录 注意：此字段可能返回 null，表示取不到有效值。 示例值：/var/lib/docker |
| Encrypt | String | 否 | 传入该参数用于创建加密云盘，取值固定为ENCRYPT 注意：此字段可能返回 null，表示取不到有效值。 示例值：ENCRYPT |
| KmsKeyId | String | 否 | 购买加密盘时自定义密钥，当传入该参数时, Encrypt入参不为空 注意：此字段可能返回 null，表示取不到有效值。 示例值：06a83929-0050-11ee-8cbc-5254001955d1 |
| SnapshotId | String | 否 | 快照ID，如果传入则根据此快照创建云硬盘，快照类型必须为数据盘快照 注意：此字段可能返回 null，表示取不到有效值。 示例值：snap-2ubk61lh |
| ThroughputPerformance | Integer | 否 | 云硬盘性能，单位：MB/s。使用此参数可给云硬盘购买额外的性能 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
Disk
节点系统盘和数据盘配置
被如下接口引用：CreateNodePool, DescribeClusterInstances, DescribeClusterMachines, DescribeNodePools, ModifyClusterMachine, ModifyNodePool。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DiskType | String | 是 | 云盘类型 示例值：CloudPremiumDiskType |
| DiskSize | Integer | 是 | 云盘大小 (G） 示例值：50 |
| AutoFormatAndMount | Boolean | 否 | 是否自动化格式盘并挂载 示例值：true |
| FileSystem | String | 否 | 文件系统 示例值：xfs |
| MountTarget | String | 否 | 挂载目录 示例值：/var/lib/containerd |
| DiskId | String | 否 | 云盘ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：disk-kped07j8 |
| Encrypt | String | 否 | 加密系统盘 注意：此字段可能返回 null，表示取不到有效值。 示例值：ENCRYPT |
| KmsKeyId | String | 否 | 自定义 KMS ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：65932f38-0106-11f1-bda4-5254008811d0 |
ExternalNodeInfo
第三方节点
被如下接口引用：DescribeClusterInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 第三方节点名称 示例值：node1 |
| CPU | Integer | CPU核数，单位：核 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| Memory | Integer | 节点内存容量，单位：GB注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
| K8SVersion | String | 第三方节点kubelet版本信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：1.20.6-tke.20 |
ExternalNodePoolInfo
第三方节点池信息
被如下接口引用：DescribeNodePools。
| 名称 | 类型 | 描述 |
|---|---|---|
| RuntimeConfig | RuntimeConfig | 第三方节点Runtime配置 |
| NodesNum | Integer | 节点数 示例值：1 |
Filter
过滤器
被如下接口引用：DescribeClusterInstances, DescribeClusterMachines, DescribeClusters, DescribeHealthCheckPolicies, DescribeHealthCheckPolicyBindings, DescribeNodePools, DescribeZoneInstanceConfigInfos。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 是 | 属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。 示例值：ClusterName |
| Values | Array of String | 是 | 属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。 示例值：cls-l6gtb5p0 |
GPUConfig
机型名称与GPU相关的参数，包括驱动版本，CUDA版本，cuDNN版本，是否开启MIG以及是否开启Fabric等相关配置信息
被如下接口引用：ModifyNodePool。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| InstanceType | String | 是 | 机型名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：GN7.2XLARGE40 |
| GPUParams | GPUParams | 是 | GPU相关的参数，包括驱动版本，CUDA版本，cuDNN版本，是否开启MIG以及是否开启Fabric等 注意：此字段可能返回 null，表示取不到有效值。 |
GPUParams
GPU相关的参数，包括驱动版本，CUDA版本，cuDNN版本，是否开启MIG以及是否开启Fabric
被如下接口引用：DescribeClusterInstances, DescribeGPUInfo, ModifyNodePool。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Driver | String | 否 | GPU驱动版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：470.82.01 |
| CUDA | String | 否 | CUDA版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：11.4 |
| CUDNN | String | 否 | CUDNN版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：7.5.0 |
| MIGEnable | Boolean | 否 | 是否启用MIG特性 注意：此字段可能返回 null，表示取不到有效值。 示例值：false |
| Fabric | Boolean | 否 | 是否启用Fabric特性 注意：此字段可能返回 null，表示取不到有效值。 示例值：false |
| CustomGPUDriver | String | 否 | 自定义驱动下载地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：http://mirrors.tencentyun.com/install/GPU/NVIDIA-Linux-x86_64-525.105.17.run |
HealthCheckPolicy
健康检测规则
被如下接口引用：CreateHealthCheckPolicy, DescribeHealthCheckPolicies, ModifyHealthCheckPolicy。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 是 | 健康检测策略名称 示例值：Node-pool1 |
| Rules | Array of HealthCheckPolicyRule | 是 | 健康检测策略规则列表 |
HealthCheckPolicyBinding
健康检测策略和节点池的绑定关系
被如下接口引用：DescribeHealthCheckPolicyBindings。
| 名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 健康检测策略名称 示例值：Node-pool1 |
| CreatedAt | String | 规则创建时间 示例值：2021-01-20 |
| NodePools | Array of String | 关联节点池数组 示例值：["np-l6gtb5p0"] |
HealthCheckPolicyRule
健康检测规则
被如下接口引用：CreateHealthCheckPolicy, DescribeHealthCheckPolicies, ModifyHealthCheckPolicy。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 是 | 健康检测规则 示例值：KubeletHealth |
| Enabled | Boolean | 是 | 是否检测此项目 示例值：true |
| AutoRepairEnabled | Boolean | 是 | 是否启用修复 示例值：true |
HealthCheckTemplate
健康检测模板
被如下接口引用：DescribeHealthCheckTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Rules | Array of HealthCheckTemplateRule | 是 | 健康检测项 |
HealthCheckTemplateRule
健康检测模板规则
被如下接口引用：DescribeHealthCheckTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 是 | 健康检测项目名称 示例值：KubeletHealth |
| Description | String | 是 | 健康检测规则描述 示例值：Check kubelet health |
| RepairAction | String | 是 | 修复动作 示例值：Reboot |
| RepairEffect | String | 是 | 修复影响 示例值：Reboot VM |
| ShouldEnable | Boolean | 是 | 是否建议开启检测 示例值：true |
| ShouldRepair | Boolean | 是 | 是否建议修复 示例值：true |
| Severity | String | 是 | 问题严重程度 示例值：general |
Instance
集群的实例信息
被如下接口引用：DescribeClusterInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例ID 示例值：ins-dw531dq |
| InstanceRole | String | 节点角色, MASTER, WORKER, ETCD, MASTER_ETCD,ALL, 默认为WORKER 示例值：WORKER |
| FailedReason | String | 实例异常(或者处于初始化中)的原因 注意：此字段可能返回 null，表示取不到有效值。 示例值：CVM is STOPPED |
| InstanceState | String | 实例的状态 - initializing创建中 - running 运行中 - failed 异常 示例值：running |
| Unschedulable | Boolean | 是否不可调度 注意：此字段可能返回 null，表示取不到有效值。 示例值：false |
| CreatedTime | String | 添加时间 示例值：2021-02-22T07:14:11Z |
| LanIP | String | 节点内网IP 注意：此字段可能返回 null，表示取不到有效值。 示例值：null |
| NodePoolId | String | 资源池ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：np-enjhles1 |
| Native | NativeNodeInfo | 原生节点参数 注意：此字段可能返回 null，表示取不到有效值。 |
| Regular | RegularNodeInfo | 普通节点参数 注意：此字段可能返回 null，表示取不到有效值。 |
| Super | SuperNodeInfo | 超级节点参数 注意：此字段可能返回 null，表示取不到有效值。 |
| External | ExternalNodeInfo | 第三方节点参数 注意：此字段可能返回 null，表示取不到有效值。 |
| NodeType | String | 节点类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：Native |
InstanceAdvancedSettings
描述了k8s集群相关配置与信息。
被如下接口引用：DescribeClusterInstances, DescribeNodePools。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DesiredPodNumber | Integer | 是 | 该节点属于podCIDR大小自定义模式时，可指定节点上运行的pod数量上限 注意：此字段可能返回 null，表示取不到有效值。 示例值：16 |
| PreStartUserScript | String | 是 | base64 编码的用户脚本，在初始化节点之前执行，目前只对添加已有节点生效 注意：此字段可能返回 null，表示取不到有效值。 示例值：#!/bin/sh echo "hello world" |
| RuntimeConfig | RuntimeConfig | 否 | 运行时描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"RuntimeType":"containerd","RuntimeVersion":"1.4.3","RuntimeRootDir":"/var/lib/containerd"} |
| UserScript | String | 否 | base64 编码的用户脚本, 此脚本会在 k8s 组件运行后执行, 需要用户保证脚本的可重入及重试逻辑, 脚本及其生成的日志文件可在节点的 /data/ccs_userscript/ 路径查看, 如果要求节点需要在进行初始化完成后才可加入调度, 可配合 unschedulable 参数使用, 在 userScript 最后初始化完成后, 添加 kubectl uncordon nodename --kubeconfig=/root/.kube/config 命令使节点加入调度 注意：此字段可能返回 null，表示取不到有效值。 示例值：#!/bin/sh echo "hello world" |
| ExtraArgs | InstanceExtraArgs | 否 | 节点相关的自定义参数信息 注意：此字段可能返回 null，表示取不到有效值。 |
InstanceChargePrepaid
包年包月配置
被如下接口引用：CreateNodePool, DescribeNodePools, ModifyClusterMachine, ModifyNodePool。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Period | Integer | 否 | 后付费计费周期，单位（月）： 1，2，3，4，5，6，7， 8，9，10，11，12，24，36，48，60 示例值：1 |
| RenewFlag | String | 否 | 预付费续费方式： - NOTIFY_AND_AUTO_RENEW：通知用户过期，且自动续费 - NOTIFY_AND_MANUAL_RENEW：通知用户过期，但不自动续费(默认) - DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知用户过期，也不自动续费 示例值：NOTIFY_AND_AUTO_RENEW |
InstanceExtraArgs
节点自定义参数
被如下接口引用：DescribeClusterInstances, DescribeNodePools。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Kubelet | Array of String | 否 | kubelet自定义参数，参数格式为["k1=v1", "k1=v2"]， 例如["root-dir=/var/lib/kubelet","feature-gates=PodShareProcessNamespace=true,DynamicKubeletConfig=true"] 注意：此字段可能返回 null，表示取不到有效值。 示例值：["--max-pods=110"] |
IntOrString
数值结构
被如下接口引用：CreateNodePool, ModifyNodePool。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | Integer | 是 | 数值类型，0是int, 1是字符串 注意：此字段可能返回 null，表示取不到有效值。 示例值：Int |
| IntVal | Integer | 否 | 整数 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
| StrVal | String | 否 | 字符串 注意：此字段可能返回 null，表示取不到有效值。 示例值：20% |
InternetAccessible
公网带宽
被如下接口引用：CreateNodePool, DescribeClusterInstances, DescribeClusterMachines, DescribeNodePools。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| MaxBandwidthOut | Integer | 是 | 带宽，单位为Mbps 示例值：50 |
| ChargeType | String | 是 | 网络计费方式 示例值：TrafficPostpaidByHour |
| BandwidthPackageId | String | 否 | 带宽包 ID 示例值：BandwidthPackageId |
Label
k8s中标签，一般以数组的方式存在
被如下接口引用：CreateNodePool, DescribeNodePools, ModifyNodePool。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 是 | map表中的Name 示例值：k8s-app |
| Value | String | 是 | map表中的Value 示例值：billing |
LifecycleConfig
节点池自定义脚本
被如下接口引用：CreateNodePool, DescribeNodePools, ModifyNodePool。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| PreInit | String | 否 | 节点初始化前自定义脚本 注意：此字段可能返回 null，表示取不到有效值。 示例值：aGVsbG8gd29ybGQK |
| PostInit | String | 否 | 节点初始化后自定义脚本 注意：此字段可能返回 null，表示取不到有效值。 示例值：aGVsbG8gd29ybGQK |
Machine
节点信息
被如下接口引用：DescribeClusterMachines。
| 名称 | 类型 | 描述 |
|---|---|---|
| MachineName | String | 节点名称 示例值：np-xxxxxxxx-7j9rt |
| MachineState | String | Machine 状态 示例值：Running |
| Zone | String | Machine 所在可用区 示例值：ap-guangzhou-1 |
| InstanceChargeType | String | 节点计费类型。PREPAID：包年包月；POSTPAID_BY_HOUR：按量计费（默认）； 示例值：PrepaidChargeType |
| CreatedAt | String | 创建时间 示例值：2022-05-20 10:03:19 |
| LoginStatus | String | Machine 登录状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：Opened |
| IsProtectedFromScaleIn | Boolean | 是否开启缩容保护 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| DisplayName | String | Machine 名字 注意：此字段可能返回 null，表示取不到有效值。 示例值：testmachine |
| CPU | Integer | CPU核数，单位：核 示例值：1 |
| GPU | Integer | GPU核数，单位：核 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| RenewFlag | String | 自动续费标识 示例值：NOTIFY_AND_MANUAL_RENEW |
| PayMode | String | 节点计费模式（已弃用） 示例值：POSTPAID_BY_HOUR |
| Memory | Integer | 节点内存容量，单位：GB示例值：50 |
| SystemDisk | Disk | 节点系统盘配置信息 |
| InternetAccessible | InternetAccessible | 公网带宽相关信息设置 |
| InstanceFamily | String | 机型所属机型族 示例值：S2 |
| LanIP | String | 节点内网 IP 示例值：1.1.1.1 |
| InstanceType | String | 机型 示例值：S2.SMALL2 |
| ExpiredTime | String | 包年包月节点计费过期时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2023-03-01 20:28:52 |
MachineSetScaling
节点池弹性伸缩配置
被如下接口引用：CreateNodePool, DescribeNodePools, ModifyNodePool。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| MinReplicas | Integer | 否 | 节点池最小副本数 示例值：1 |
| MaxReplicas | Integer | 否 | 节点池最大副本数 示例值：10 |
| CreatePolicy | String | 否 | 节点池扩容策略。ZoneEquality：多可用区打散；ZonePriority：首选可用区优先； 注意：此字段可能返回 null，表示取不到有效值。 示例值：ZoneEquality |
MachineUpgradeSettings
托管节点池自动升级配置
被如下接口引用：CreateNodePool, DescribeNodePools, ModifyNodePool。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| AutoUpgrade | Boolean | 否 | 是否开启自动升级 示例值：true |
| UpgradeOptions | AutoUpgradeOptions | 否 | 运维窗口 |
| Components | Array of String | 否 | 升级项 注意：此字段可能返回 null，表示取不到有效值。 示例值：["kubelet","kernel"] |
| MaxUnavailable | IntOrString | 否 | 升级时，最大不可升级的节点数 |
ManagementConfig
托管节点池Management配置
被如下接口引用：CreateNodePool, DescribeNodePools, ModifyNodePool。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Nameservers | Array of String | 否 | dns 配置 注意：此字段可能返回 null，表示取不到有效值。 示例值：["nameserver 183.87.111.111"] |
| Hosts | Array of String | 否 | hosts 配置 注意：此字段可能返回 null，表示取不到有效值。 示例值：["127.0.0.1 iam.marmotedu.com"] |
| KernelArgs | Array of String | 否 | 内核参数配置 注意：此字段可能返回 null，表示取不到有效值。 示例值：["kernel.pid_max=4194304"] |
ManuallyAdded
手动加入的节点
被如下接口引用：DescribeNodePools。
| 名称 | 类型 | 描述 |
|---|---|---|
| Joining | Integer | 加入中的节点数量 示例值：0 |
| Initializing | Integer | 初始化中的节点数量 示例值：0 |
| Normal | Integer | 正常的节点数量 示例值：1 |
| Total | Integer | 节点总数 示例值：1 |
NativeNodeInfo
节点信息
被如下接口引用：DescribeClusterInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| MachineName | String | 节点名称 示例值：np-4h43fuxj-7j9rt |
| MachineState | String | Machine 状态 示例值：Running |
| Zone | String | Machine 所在可用区 示例值：ap-guangzhou-1 |
| InstanceChargeType | String | 节点计费类型。PREPAID：包年包月；POSTPAID_BY_HOUR：按量计费（默认）； 示例值：PrepaidChargeType |
| CreatedAt | String | 创建时间 示例值：2022-05-20 10:03:19 |
| LoginStatus | String | Machine 登录状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：Opened |
| IsProtectedFromScaleIn | Boolean | 是否开启缩容保护 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| DisplayName | String | Machine 名字 注意：此字段可能返回 null，表示取不到有效值。 示例值：testmachine |
| CPU | Integer | CPU核数，单位：核 示例值：1 |
| GPU | Integer | GPU核数，单位：核 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| RenewFlag | String | 自动续费标识 示例值：NOTIFY_AND_MANUAL_RENEW |
| PayMode | String | 节点计费模式 示例值：POSTPAID_BY_HOUR |
| Memory | Integer | 节点内存容量，单位： 示例值：50 |
| SystemDisk | Disk | 节点系统盘配置信息 |
| InternetAccessible | InternetAccessible | 公网带宽相关信息设置 |
| InstanceFamily | String | 机型所属机型族 示例值：S2 |
| LanIp | String | 节点内网 IP 示例值：1.1.1.1 |
| InstanceType | String | 机型 示例值：S2.SMALL2 |
| ExpiredTime | String | 包年包月节点计费过期时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2023-03-01 20:28:52 |
| WanIp | String | 节点外网 IP 注意：此字段可能返回 null，表示取不到有效值。 示例值：1.1.1.1 |
| KeyIds | Array of String | 节点密钥 ID 列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：["key-l6gtb5p0"] |
| GPUParams | GPUParams | 节点GPU相关配置 注意：此字段可能返回 null，表示取不到有效值。 |
| DataDisks | Array of DataDisk | 数据盘列表 注意：此字段可能返回 null，表示取不到有效值。 |
| SecurityGroupIDs | Array of String | 安全组列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：["sg-4h43fuxjx"] |
| VpcId | String | VPC 唯一 ID 示例值：vpc-4h43fuxj |
| SubnetId | String | 子网唯一 ID 示例值：subnet-4h43fuxj |
| OsImage | String | OS的名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：TencentOS Server 3.1 (Final) |
| MachineType | String | 原生节点的 Machine 类型
示例值：Native, NativeCVM |
| InstanceId | String | 原生节点对应的实例 ID
注意：此字段可能返回 null，表示取不到有效值。 示例值：ins-q47ofw6r, eks-f8mvyaep |
| Tags | Array of Tag | 原生节点云标签 注意：此字段可能返回 null，表示取不到有效值。 |
NativeNodePoolInfo
原生节点池信息
被如下接口引用：DescribeNodePools。
| 名称 | 类型 | 描述 |
|---|---|---|
| Scaling | MachineSetScaling | 伸缩配置 |
| SubnetIds | Array of String | 子网列表 示例值：["subnet-4h43fuxj"] |
| SecurityGroupIds | Array of String | 安全组列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：["sg-4h43fuxj"] |
| UpgradeSettings | MachineUpgradeSettings | 自动升级配置 |
| AutoRepair | Boolean | 是否开启自愈能力 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| InstanceChargeType | String | 节点计费类型 示例值：PrepaidChargeType |
| InstanceChargePrepaid | InstanceChargePrepaid | 包年包月机型计费配置 |
| SystemDisk | Disk | 系统盘配置 |
| KeyIds | Array of String | 密钥 ID 列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：["key-l6gtb5p0"] |
| Management | ManagementConfig | Machine 系统配置 |
| HealthCheckPolicyName | String | 故障自愈规则名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：policy1 |
| HostNamePattern | String | 原生节点池hostName模式串 注意：此字段可能返回 null，表示取不到有效值。 示例值：aaa{R:3} |
| KubeletArgs | Array of String | kubelet 自定义参数 注意：此字段可能返回 null，表示取不到有效值。 示例值：["kube-api-qps=50"] |
| Lifecycle | LifecycleConfig | 预定义脚本 |
| RuntimeRootDir | String | 运行时根目录 示例值：/var/lib/docker |
| EnableAutoscaling | Boolean | 是否开启弹性伸缩 示例值：true |
| InstanceTypes | Array of String | 机型列表 示例值：["S2.4XLARGE48"] |
| Replicas | Integer | 期望节点数 示例值：10 |
| ReadyReplicas | Integer | 就绪 Machine 个数 示例值：5 |
| InternetAccessible | InternetAccessible | 公网带宽设置 |
| DataDisks | Array of DataDisk | 原生节点池数据盘 注意：此字段可能返回 null，表示取不到有效值。 |
| MachineType | String | 原生节点机型 Native, NativeCVM 示例值：Native |
NodeCountSummary
节点统计列表
被如下接口引用：DescribeNodePools。
| 名称 | 类型 | 描述 |
|---|---|---|
| ManuallyAdded | ManuallyAdded | 手动管理的节点 注意：此字段可能返回 null，表示取不到有效值。 |
| AutoscalingAdded | AutoscalingAdded | 自动管理的节点 注意：此字段可能返回 null，表示取不到有效值。 |
NodePool
节点池信息
被如下接口引用：DescribeNodePools。
| 名称 | 类型 | 描述 |
|---|---|---|
| ClusterId | String | 集群 ID 示例值：cls-4h43fuxj |
| NodePoolId | String | 节点池 ID 示例值：np-4h43fuxj |
| Tags | Array of TagSpecification | 节点标签 注意：此字段可能返回 null，表示取不到有效值。 |
| Taints | Array of Taint | 节点污点 注意：此字段可能返回 null，表示取不到有效值。 |
| DeletionProtection | Boolean | 是否开启删除保护 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| Unschedulable | Boolean | 节点是否不可调度 注意：此字段可能返回 null，表示取不到有效值。 示例值：false |
| Type | String | 节点池类型 示例值：Hosted |
| Labels | Array of Label | 节点 Labels 注意：此字段可能返回 null，表示取不到有效值。 |
| LifeState | String | 节点池状态 示例值：Running |
| CreatedAt | String | 创建时间 示例值：2022-05-20 10:03:19 |
| Name | String | 节点池名称 示例值：testnodepool |
| Native | NativeNodePoolInfo | 原生节点池参数 注意：此字段可能返回 null，表示取不到有效值。 |
| Annotations | Array of Annotation | 节点 Annotation 列表 注意：此字段可能返回 null，表示取不到有效值。 |
| Super | SuperNodePoolInfo | 超级节点池参数，在Type等于Super该字段才有值 注意：此字段可能返回 null，表示取不到有效值。 |
| Regular | RegularNodePoolInfo | 普通节点池参数，在Type等于Regular该字段才有值 注意：此字段可能返回 null，表示取不到有效值。 |
| External | ExternalNodePoolInfo | 第三方节点池参数，在Type等于External该字段才有值 注意：此字段可能返回 null，表示取不到有效值。 |
RegularNodeInfo
普通节点信息
被如下接口引用：DescribeClusterInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceAdvancedSettings | InstanceAdvancedSettings | 节点配置 注意：此字段可能返回 null，表示取不到有效值。 |
| AutoscalingGroupId | String | 自动伸缩组ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：asg-eweq21 |
| Tags | Array of Tag | 普通节点云标签 注意：此字段可能返回 null，表示取不到有效值。 |
RegularNodePoolInfo
普通节点池信息
被如下接口引用：DescribeNodePools。
| 名称 | 类型 | 描述 |
|---|---|---|
| LaunchConfigurationId | String | LaunchConfigurationId 配置 示例值：asc-4h43fuxj |
| AutoscalingGroupId | String | AutoscalingGroupId 分组id 示例值：asg-4h43fuxj |
| NodeCountSummary | NodeCountSummary | NodeCountSummary 节点列表 示例值：{"AutoscalingAdded":{"Initializing":0,"Joining":0,"Normal":1,"Sh |
| AutoscalingGroupStatus | String | 状态信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：enabled |
| MaxNodesNum | Integer | 最大节点数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：5 |
| MinNodesNum | Integer | 最小节点数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| DesiredNodesNum | Integer | 期望的节点数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：3 |
| NodePoolOs | String | 节点池osName 注意：此字段可能返回 null，表示取不到有效值。 示例值：tlinux2.4x86_64 |
| InstanceAdvancedSettings | InstanceAdvancedSettings | 节点配置 注意：此字段可能返回 null，表示取不到有效值。 |
RuntimeConfig
运行时配置
被如下接口引用：DescribeClusterInstances, DescribeNodePools。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| RuntimeType | String | 否 | 运行时类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：docker |
| RuntimeVersion | String | 否 | 运行时版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：1.19 |
| RuntimeRootDir | String | 否 | 运行时根目录 注意：此字段可能返回 null，表示取不到有效值。 示例值：/var/lib/docker |
SortBy
排序信息
被如下接口引用：DescribeClusterInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| FieldName | String | 否 | 排序指标 示例值：CreatedTime |
| OrderType | String | 否 | 排序方式 示例值：asc |
SuperNodeInfo
超级节点信息
被如下接口引用：DescribeClusterInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 实例名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：eklet-subnet-4h43fuxj |
| AutoRenewFlag | Integer | 自动续费标识 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| ResourceType | String | 资源类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：supernode |
| CPU | Float | 节点的 CPU 规格，单位：核。 注意：此字段可能返回 null，表示取不到有效值。 示例值：100 |
| UsedCPU | Float | 节点上 Pod 的 CPU总和，单位：核。 注意：此字段可能返回 null，表示取不到有效值。 示例值：20 |
| Memory | Float | 节点的内存规格，单位：Gi。 注意：此字段可能返回 null，表示取不到有效值。 示例值：400 |
| UsedMemory | Float | 节点上 Pod 的内存总和，单位：Gi。 注意：此字段可能返回 null，表示取不到有效值。 示例值：80 |
| Zone | String | 可用区 注意：此字段可能返回 null，表示取不到有效值。 示例值："ap-guangzhou-3" |
| VpcId | String | VPC 唯一 ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：vpc-4h43fuxj |
| SubnetId | String | 子网唯一 ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：subnet-4h43fuxj |
| ActiveAt | String | 生效时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2022-05-17 13:22:28 |
| ExpireAt | String | 过期时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2022-06-17 13:22:28 |
| MaxCPUScheduledPod | Integer | 可调度的单 Pod 最大 CPU 规格 注意：此字段可能返回 null，表示取不到有效值。 示例值：8 |
| InstanceAttribute | String | 实例属性 注意：此字段可能返回 null，表示取不到有效值。 示例值：eyJMYWJlbHMiOnt9LCJUYWludHMiOltdLCJTZWN1cml0eUdyb3VwSURzIjpbInNnLTJidGlyamhqIl0sIlVuc2NoZWR1bGUiOmZhbHNlfQ== |
| NodeName | String | 节点名称 示例值：eklet-4h43fuxj |
| Duration | String | 包销时长 示例值：5y |
| ResourceId | String | 预付费资源ID 示例值：kn-79sn38nq |
SuperNodePoolInfo
虚拟节点池信息
被如下接口引用：DescribeNodePools。
| 名称 | 类型 | 描述 |
|---|---|---|
| SubnetIds | Array of String | 子网列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：["subnet-5rfwjp0m"] |
| SecurityGroupIds | Array of String | 安全组列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：["sg-p0ul5pgt"] |
Tag
标签绑定的资源类型，当前支持类型："cluster"
被如下接口引用：CreateNodePool, DescribeClusterInstances, ModifyNodePool。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Key | String | 否 | 标签键 示例值：key |
| Value | String | 否 | 标签值 示例值：value |
TagSpecification
标签描述列表。通过指定该参数可以同时绑定标签到相应的资源实例，当前仅支持绑定标签到云主机实例。
被如下接口引用：CreateNodePool, DescribeClusters, DescribeNodePools, ModifyNodePool。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ResourceType | String | 否 | 标签绑定的资源类型，当前支持类型： 1.cluster：集群相关接口，TagSpecification 的 ResourceType 传参为 cluster 2.machine：节点池相关接口，如：CreateNodePool, DescribeNodePools 等，TagSpecification 的 ResourceType 传参为 machine 注意：此字段可能返回 null，表示取不到有效值。 示例值：cluster |
| Tags | Array of Tag | 否 | 标签对列表 注意：此字段可能返回 null，表示取不到有效值。 |
Taint
kubernetes Taint
被如下接口引用：CreateNodePool, DescribeNodePools, ModifyNodePool。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Key | String | 否 | Taint的Key 示例值：key1 |
| Value | String | 否 | Taint的Value 示例值：value1 |
| Effect | String | 否 | Taint的Effect 示例值：NoSchedule |
UpdateNativeNodePoolParam
修改原生节点池参数
被如下接口引用：ModifyNodePool。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Scaling | MachineSetScaling | 否 | 伸缩配置 |
| SubnetIds | Array of String | 否 | 子网列表 示例值：["subnet-4h43fuxj"] |
| SecurityGroupIds | Array of String | 否 | 安全组列表 示例值：["sg-4h43fuxj"] |
| UpgradeSettings | MachineUpgradeSettings | 否 | 自动升级配置 |
| AutoRepair | Boolean | 否 | 是否开启自愈能力 示例值：true |
| InstanceChargeType | String | 否 | 计费类型 枚举值：
示例值：PREPAID |
| InstanceChargePrepaid | InstanceChargePrepaid | 否 | 包年包月机型计费配置 |
| SystemDisk | Disk | 否 | 系统盘配置 |
| Management | ManagementConfig | 否 | Machine 系统配置 |
| HealthCheckPolicyName | String | 否 | 故障自愈规则名称 示例值：policy1 |
| HostNamePattern | String | 否 | 原生节点池hostName模式串 示例值：aaa{R:3} |
| KubeletArgs | Array of String | 否 | kubelet 自定义参数 示例值：["kube-api-qps=50"] |
| Lifecycle | LifecycleConfig | 否 | 预定义脚本 |
| RuntimeRootDir | String | 否 | 运行时根目录 示例值：/var/lib/docker |
| EnableAutoscaling | Boolean | 否 | 是否开启弹性伸缩 示例值：true |
| InstanceTypes | Array of String | 否 | 机型列表 示例值：["S2.4XLARGE48"] |
| Replicas | Integer | 否 | 期望节点数 示例值：10 |
| UpdateExistedNode | Boolean | 否 | 是否更新存量节点MetaData(包括： metadata、annotation、label) 示例值：false |
| DataDisks | Array of DataDisk | 否 | 数据盘列表 |
| UpdateMachineManagement | String | 否 | 节点management参数存量更新开关，有enable（打开）、disable（关闭）两个状态可选 management包括：nameserver、host、kubelet、kernel参数 示例值：disable |
| KeyIds | Array of String | 否 | ssh公钥id数组 示例值：["sky-l6gtb5p0","sky-l6gtb5p1"] |
| DeletePolicy | String | 否 | 节点移出策略，有Random（随机）、Newest（优先移出最新实例）、Oldest（优先移出最旧实例）三种可选，默认是Newest 示例值：Newest |
| GPUConfigs | Array of GPUConfig | 否 | 节点池 GPU 配置 |
| AutomationService | Boolean | 否 | 原生节点池安装自动化助手开关状态 示例值：true |
| Password | String | 否 | 原生节点池密码 示例值：Paas@123 |
