kubelet 参数（kubelet config）

大家好，我是讯享网，很高兴认识大家。

addon的具体描述

被如下接口引用：DescribeAddon。

名称类型描述 AddonName String addon名称 AddonVersion String addon的版本 RawValues String addon的参数，是一个json格式的base64转码后的字符串
注意：此字段可能返回 null，表示取不到有效值。 Phase String addon的状态
注意：此字段可能返回 null，表示取不到有效值。 Reason String addon失败的原因
注意：此字段可能返回 null，表示取不到有效值。

注释

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

名称类型必选描述 Name String 是注释键
示例值："" Value String 是注释值
示例值：""

app所支持的chart

被如下接口引用：GetTkeAppChartList。

名称类型描述 Name String chart名称 Label String chart的标签
注意：此字段可能返回 null，表示取不到有效值。 LatestVersion String chart的版本

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

被如下接口引用：ModifyClusterAsGroupAttribute。

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

自动变配集群等级

被如下接口引用：CreateCluster, ModifyClusterAttribute。

名称类型必选描述 IsAutoUpgrade Boolean 是是否开启自动变配集群等级
示例值：true

自动扩缩容的节点

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

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

仓储仓库信息

被如下接口引用：DescribeBackupStorageLocations。

名称类型描述 Name String 备份仓库名称
示例值：test StorageRegion String 存储仓库所属地域，比如COS广州(ap-guangzhou)
示例值：ap-guangzhou Provider String 存储服务提供方，默认腾讯云
注意：此字段可能返回 null，表示取不到有效值。
示例值：tencentcloud Bucket String 对象存储桶名称，如果是COS必须是tke-backup-前缀开头
注意：此字段可能返回 null，表示取不到有效值。
示例值：tke-backup-xxx Path String 对象存储桶路径
注意：此字段可能返回 null，表示取不到有效值。
示例值：test State String 存储仓库状态
注意：此字段可能返回 null，表示取不到有效值。
示例值：Available/Unavailable Message String 详细状态信息
注意：此字段可能返回 null，表示取不到有效值。 LastValidationTime String 最后一次检查时间
注意：此字段可能返回 null，表示取不到有效值。

cuDNN的版本信息

被如下接口引用：AddExistedInstances, CreateCluster, CreateClusterInstances, CreateClusterNodePool, DescribeClusterNodePoolDetail, DescribeClusterNodePools, ModifyClusterNodePool, ScaleOutClusterMaster。

名称类型必选描述 Version String 是 cuDNN的版本
注意：此字段可能返回 null，表示取不到有效值。
示例值：7.5.0 Name String 是 cuDNN的名字
注意：此字段可能返回 null，表示取不到有效值。
示例值：libcudnn7_7.5.0.56-1+cuda10.1_amd64.deb DocName String 否 cuDNN的Doc名字
注意：此字段可能返回 null，表示取不到有效值。
示例值：libcudnn7-doc_7.5.0.56-1+cuda10.1_amd64.deb DevName String 否 cuDNN的Dev名字
注意：此字段可能返回 null，表示取不到有效值。
示例值：libcudnn7-dev_7.5.0.56-1+cuda10.1_amd64.deb

cloudrun安全特性能力

被如下接口引用：CreateEKSContainerInstances, DescribeEKSContainerInstances, UpdateEKSContainerInstance。

名称类型必选描述 Add Array of String 否启用安全能力项列表
注意：此字段可能返回 null，表示取不到有效值。
示例值：["NET_ADMIN", "SYS_TIME"] Drop Array of String 否禁用安全能力向列表
注意：此字段可能返回 null，表示取不到有效值。
示例值：["NET_ADMIN"]

EKS Instnace CBS volume

被如下接口引用：CreateEKSContainerInstances, UpdateEKSContainerInstance。

名称类型必选描述 Name String 是 cbs volume 数据卷名称
示例值：[] CbsDiskId String 是腾讯云cbs盘Id
示例值：[]

集群信息结构体

被如下接口引用：DescribeClusters。

名称类型描述 ClusterId String 集群ID
示例值：cls-xxxxxxx ClusterName String 集群名称
示例值：集群 ClusterDescription String 集群描述
示例值：示例集群 ClusterVersion String 集群版本（默认值为1.10.5）
示例值：1.20.6 ClusterOs String 集群系统。centos7.2x86_64 或者 ubuntu16.04.1 LTSx86_64，默认取值为ubuntu16.04.1 LTSx86_64
示例值：ubuntu16.04.1 LTSx86_64 ClusterType String 集群类型，托管集群：MANAGED_CLUSTER，独立集群：INDEPENDENT_CLUSTER。
示例值：INDEPENDENT_CLUSTER ClusterNetworkSettings ClusterNetworkSettings 集群网络相关参数 ClusterNodeNum Integer 集群当前node数量
示例值：3 ProjectId Integer 集群所属的项目ID
示例值：0 TagSpecification Array of TagSpecification 标签描述列表。
注意：此字段可能返回 null，表示取不到有效值。 ClusterStatus String 集群状态 (Trading 集群开通中,Creating 创建中,Running 运行中,Deleting 删除中,Idling 闲置中,Recovering 唤醒中,Scaling 规模调整中,Upgrading 升级中,WaittingForConnect 等待注册,Trading 集群开通中,Isolated 欠费隔离中,Pause 集群升级暂停,NodeUpgrading 节点升级中,RuntimeUpgrading 节点运行时升级中,MasterScaling Master扩缩容中,ClusterLevelUpgrading 调整规格中,ResourceIsolate 隔离中,ResourceIsolated 已隔离,ResourceReverse 冲正中,Abnormal 异常)
示例值：Running Property String 集群属性(包括集群不同属性的MAP，属性字段包括NodeNameType (lan-ip模式和hostname 模式，默认无lan-ip模式))
注意：此字段可能返回 null，表示取不到有效值。
示例值：{“NodeNameType”:“lan-ip”,“NetworkType”:“GR”} ClusterMaterNodeNum Integer 集群当前master数量
示例值：1 ImageId String 集群使用镜像id
注意：此字段可能返回 null，表示取不到有效值。 OsCustomizeType String OsCustomizeType 系统定制类型
注意：此字段可能返回 null，表示取不到有效值。
示例值：GENERAL ContainerRuntime String 集群运行环境docker或container
注意：此字段可能返回 null，表示取不到有效值。
示例值：docker CreatedTime String 创建时间
注意：此字段可能返回 null，表示取不到有效值。
示例值：2021-06-16T07:42:57Z DeletionProtection Boolean 删除保护开关
注意：此字段可能返回 null，表示取不到有效值。
示例值：false EnableExternalNode Boolean 集群是否开启第三方节点支持
注意：此字段可能返回 null，表示取不到有效值。
示例值：false ClusterLevel String 集群等级，针对托管集群生效
注意：此字段可能返回 null，表示取不到有效值。
示例值：L5 AutoUpgradeClusterLevel Boolean 自动变配集群等级，针对托管集群生效
注意：此字段可能返回 null，表示取不到有效值。
示例值：true QGPUShareEnable Boolean 是否开启QGPU共享
注意：此字段可能返回 null，表示取不到有效值。
示例值：false RuntimeVersion String 运行时版本
注意：此字段可能返回 null，表示取不到有效值。
示例值：1.4.3 ClusterEtcdNodeNum Integer 集群当前etcd数量
注意：此字段可能返回 null，表示取不到有效值。
示例值：1 CdcId String 本地专用集群Id
注意：此字段可能返回 null，表示取不到有效值。
示例值：cluster-0jend45y

集群高级配置

被如下接口引用：CreateCluster。

名称类型必选描述 IPVS Boolean 否是否启用IPVS
示例值：false AsEnabled Boolean 否是否启用集群节点自动扩缩容(创建集群流程不支持开启此功能)
示例值：false ContainerRuntime String 否集群使用的runtime类型，包括"docker"和"containerd"两种类型，默认为"docker"
示例值：docker NodeNameType String 否集群中节点NodeName类型（包括 hostname,lan-ip两种形式，默认为lan-ip。如果开启了hostname模式，创建节点时需要设置HostName参数，并且InstanceName需要和HostName一致）
示例值：lan-ip ExtraArgs ClusterExtraArgs 否集群自定义参数 NetworkType String 否集群网络类型（包括GR(全局路由)和VPC-CNI两种模式，默认为GR。
示例值：GR IsNonStaticIpMode Boolean 否集群VPC-CNI模式是否为非固定IP，默认: FALSE 固定IP。
示例值：false DeletionProtection Boolean 否是否启用集群删除保护
示例值：false KubeProxyMode String 否集群的网络代理模型，目前tke集群支持的网络代理模式有三种：iptables,ipvs,ipvs-bpf，此参数仅在使用ipvs-bpf模式时使用，三种网络模式的参数设置关系如下：
iptables模式：IPVS和KubeProxyMode都不设置
ipvs模式: 设置IPVS为true, KubeProxyMode不设置
ipvs-bpf模式: 设置KubeProxyMode为kube-proxy-bpf
使用ipvs-bpf的网络模式需要满足以下条件：
1. 集群版本必须为1.14及以上；
2. 系统镜像必须是: Tencent Linux 2.4；
示例值：kube-proxy-eni AuditEnabled Boolean 否是否开启审计开关
示例值：false AuditLogsetId String 否审计日志上传到的logset日志集 AuditLogTopicId String 否审计日志上传到的topic VpcCniType String 否区分共享网卡多IP模式和独立网卡模式，共享网卡多 IP 模式填写"tke-route-eni"，独立网卡模式填写"tke-direct-eni"，默认为共享网卡模式
示例值：tke-direct-eni RuntimeVersion String 否运行时版本
示例值：1.16.3 EnableCustomizedPodCIDR Boolean 否是否开节点podCIDR大小的自定义模式
示例值：false BasePodNumber Integer 否自定义模式下的基础pod数量
示例值：16 CiliumMode String 否启用 CiliumMode 的模式，空值表示不启用，“clusterIP” 表示启用 Cilium 支持 ClusterIP
示例值：clusterIP IsDualStack Boolean 否集群VPC-CNI模式下是否是双栈集群，默认false，表明非双栈集群。
示例值：false QGPUShareEnable Boolean 否是否开启QGPU共享
示例值：false

集群关联的伸缩组信息

被如下接口引用：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 创建时间

集群伸缩组属性

被如下接口引用：ModifyClusterAsGroupAttribute。

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

集群弹性伸缩配置

被如下接口引用：DescribeClusterAsGroupOption, ModifyClusterAsGroupOptionAttribute。

名称类型必选描述 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的节点是否不缩容(默认： true)
注意：此字段可能返回 null，表示取不到有效值。 SkipNodesWithSystemPods Boolean 否含有kube-system namespace下非DaemonSet管理的Pod的节点是否不缩容 (默认： true)
注意：此字段可能返回 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，表示取不到有效值。

描述集群的基本配置信息

被如下接口引用：CreateCluster。

名称类型必选描述 ClusterOs String 否集群操作系统，支持设置公共镜像(字段传相应镜像Name)和自定义镜像(字段传相应镜像ID)，详情参考：https://cloud.tencent.com/document/product/457/68289
示例值：tlinux2.4x86_64 ClusterVersion String 否集群版本,默认值为1.10.5
示例值：1.18.4 ClusterName String 否集群名称
示例值：clstest ClusterDescription String 否集群描述
示例值：test cluster VpcId String 否私有网络ID，形如vpc-xxx。创建托管空集群时必传。
示例值：vpc-xxx ProjectId Integer 否集群内新增资源所属项目ID。
示例值：0 TagSpecification Array of TagSpecification 否标签描述列表。通过指定该参数可以同时绑定标签到相应的资源实例，当前仅支持绑定标签到集群实例。 OsCustomizeType String 否容器的镜像版本，"DOCKER_CUSTOMIZE"(容器定制版),"GENERAL"(普通版本，默认值)
示例值：GENERAL NeedWorkSecurityGroup Boolean 否是否开启节点的默认安全组(默认: 否，Alpha特性)
示例值：false SubnetId String 否当选择Cilium Overlay网络插件时，TKE会从该子网获取2个IP用来创建内网负载均衡
示例值：subnet-xx ClusterLevel String 否集群等级，针对托管集群生效
示例值：L5 AutoUpgradeClusterLevel AutoUpgradeClusterLevel 否自动变配集群等级，针对托管集群生效

集群容器网络相关参数

被如下接口引用：CreateCluster。

名称类型必选描述 ClusterCIDR String 否用于分配集群容器和服务 IP 的 CIDR，不得与 VPC CIDR 冲突，也不得与同 VPC 内其他集群 CIDR 冲突。且网段范围必须在内网网段内，例如:10.1.0.0/14, 192.168.0. ¹⁄ ₁₈,172.16.0.0/16。
示例值：10.0.0.0/16 IgnoreClusterCIDRConflict Boolean 否是否忽略 ClusterCIDR 冲突错误, 默认不忽略
示例值：false MaxNodePodNum Integer 否集群中每个Node上最大的Pod数量。取值范围16～256。不为2的幂值时会向上取最接近的2的幂值。
示例值：256 MaxClusterServiceNum Integer 否集群最大的service数量。取值范围32～32768，不为2的幂值时会向上取最接近的2的幂值。默认值256
示例值：256 ServiceCIDR String 否用于分配集群服务 IP 的 CIDR，不得与 VPC CIDR 冲突，也不得与同 VPC 内其他集群 CIDR 冲突。且网段范围必须在内网网段内，例如:10.1.0.0/14, 192.168.0. ¹⁄ ₁₈,172.16.0.0/16。
示例值：10.0.255.0/24 EniSubnetIds Array of String 否 VPC-CNI网络模式下，弹性网卡的子网Id。
示例值：["subnet-aaa"] ClaimExpiredSeconds Integer 否 VPC-CNI网络模式下，弹性网卡IP的回收时间，取值范围[300,)
示例值：120 IgnoreServiceCIDRConflict Boolean 否是否忽略 ServiceCIDR 冲突错误, 仅在 VPC-CNI 模式生效，默认不忽略
示例值：false

集群创建过程

被如下接口引用：DescribeTKEEdgeClusterStatus。

名称类型描述 Type String 集群创建过程类型 Status String 集群创建过程状态 LastProbeTime Timestamp 最后一次探测到该状态的时间
注意：此字段可能返回 null，表示取不到有效值。 LastTransitionTime Timestamp 最后一次转换到该过程的时间
注意：此字段可能返回 null，表示取不到有效值。 Reason String 转换到该过程的简明原因
注意：此字段可能返回 null，表示取不到有效值。 Message String 转换到该过程的更多信息
注意：此字段可能返回 null，表示取不到有效值。

接入k8s 的认证信息

被如下接口引用：DescribeEKSClusterCredential, DescribeTKEEdgeClusterCredential。

名称类型必选描述 CACert String 是 CA 根证书 Token String 否认证用的Token

集群master自定义参数

被如下接口引用：CreateCluster, DescribeClusterExtraArgs, ScaleOutClusterMaster, UpdateClusterVersion。

名称类型必选描述 KubeAPIServer Array of String 否 kube-apiserver自定义参数，参数格式为["k1=v1", "k1=v2"]，例如["max-requests-inflight=500","feature-gates=PodShareProcessNamespace=true,DynamicKubeletConfig=true"]
注意：此字段可能返回 null，表示取不到有效值。
示例值：["max-requests-inflight=200"] KubeControllerManager Array of String 否 kube-controller-manager自定义参数
注意：此字段可能返回 null，表示取不到有效值。
示例值：["kube-api-burst=500"] KubeScheduler Array of String 否 kube-scheduler自定义参数
注意：此字段可能返回 null，表示取不到有效值。
示例值：["kube-api-burst=500"] Etcd Array of String 否 etcd自定义参数，只支持独立集群
注意：此字段可能返回 null，表示取不到有效值。
示例值：["node-data-dir=/data"]

弹性容器集群内网访问LB信息

被如下接口引用：DescribeEKSClusterCredential, UpdateEKSCluster。

名称类型必选描述 Enabled Boolean 是是否开启内网访问LB
注意：此字段可能返回 null，表示取不到有效值。 SubnetId String 否内网访问LB关联的子网Id
注意：此字段可能返回 null，表示取不到有效值。

托管集群等级属性

被如下接口引用：DescribeClusterLevelAttribute。

名称类型描述 Name String 集群等级
示例值：L500 Alias String 等级名称
示例值：500节点 NodeCount Integer 节点数量
示例值：20 PodCount Integer Pod数量
示例值：100 ConfigMapCount Integer Configmap数量
示例值：200 RSCount Integer ReplicaSets数量
示例值：500 CRDCount Integer CRD数量
示例值：500 Enable Boolean 是否启用
示例值：true OtherCount Integer 其他资源数量
注意：此字段可能返回 null，表示取不到有效值。
示例值：500

集群等级变配记录

被如下接口引用：DescribeClusterLevelChangeRecords。

名称类型描述 ID String 记录ID
示例值：xxxx-xxxx-xxxx-xxxx ClusterID String 集群ID
示例值：cls-xxxxxx Status String 变配状态：trading 发货中,upgrading 变配中,success 变配成功,failed 变配失败。
示例值：success Message String 状态描述
示例值：余额不足 OldLevel String 变配前规模
示例值：L5 NewLevel String 变配后规模
示例值：L20 TriggerType String 变配触发类型：manual 手动,auto 自动
示例值：manual CreatedAt String 创建时间
示例值：2022-02-01 00:00:00 StartedAt String 开始时间
示例值：2022-02-01 00:00:00 EndedAt String 结束时间
示例值：2022-02-01 00:00:00

集群网络相关的参数

被如下接口引用：DescribeClusters。

名称类型描述 ClusterCIDR String 用于分配集群容器和服务 IP 的 CIDR，不得与 VPC CIDR 冲突，也不得与同 VPC 内其他集群 CIDR 冲突
示例值：10.0.0.0/24 IgnoreClusterCIDRConflict Boolean 是否忽略 ClusterCIDR 冲突错误, 默认不忽略
示例值：false MaxNodePodNum Integer 集群中每个Node上最大的Pod数量(默认为256)
示例值：256 MaxClusterServiceNum Integer 集群最大的service数量(默认为256)
示例值：256 Ipvs Boolean 是否启用IPVS(默认不开启)
示例值：false VpcId String 集群的VPCID（如果创建空集群，为必传值，否则自动设置为和集群的节点保持一致）
示例值：vpc-aaa Cni Boolean 网络插件是否启用CNI(默认开启)
示例值：false KubeProxyMode String service的网络模式，当前参数只适用于ipvs+bpf模式
注意：此字段可能返回 null，表示取不到有效值。
示例值：ipvs-bpf ServiceCIDR String 用于分配service的IP range，不得与 VPC CIDR 冲突，也不得与同 VPC 内其他集群 CIDR 冲突
注意：此字段可能返回 null，表示取不到有效值。
示例值：10.0.0.0/25 Subnets Array of String 集群关联的容器子网
注意：此字段可能返回 null，表示取不到有效值。
示例值：["subnet-aa","subnet-bb"] IgnoreServiceCIDRConflict Boolean 是否忽略 ServiceCIDR 冲突错误, 仅在 VPC-CNI 模式生效，默认不忽略
注意：此字段可能返回 null，表示取不到有效值。
示例值：false IsDualStack Boolean 集群VPC-CNI模式是否为非双栈集群，默认false，非双栈。
注意：此字段可能返回 null，表示取不到有效值。
示例值：false Ipv6ServiceCIDR String 用于分配service的IP range，由系统自动分配
注意：此字段可能返回 null，表示取不到有效值。
示例值：10.0.0.0/24 CiliumMode String 集群Cilium Mode配置
- clusterIP
注意：此字段可能返回 null，表示取不到有效值。
示例值："clusterIP"

集群属性

被如下接口引用：ModifyClusterAttribute。

名称类型必选描述 NodeNameType String 否节点hostname命名模式
注意：此字段可能返回 null，表示取不到有效值。
示例值：hostname

弹性容器集群公网访问负载均衡信息

被如下接口引用：DescribeEKSClusterCredential, UpdateEKSCluster。

名称类型必选描述 Enabled Boolean 是是否开启公网访问LB
注意：此字段可能返回 null，表示取不到有效值。
示例值：true AllowFromCidrs Array of String 否允许访问的来源CIDR列表
注意：此字段可能返回 null，表示取不到有效值。
示例值：[] SecurityPolicies Array of String 否安全策略放通单个IP或CIDR(例如: "192.168.1.0/24",默认为拒绝所有)
注意：此字段可能返回 null，表示取不到有效值。
示例值：[] ExtraParam String 否外网访问相关的扩展参数，格式为json
注意：此字段可能返回 null，表示取不到有效值。
示例值：{} SecurityGroup String 否新内外网功能，需要传递安全组
注意：此字段可能返回 null，表示取不到有效值。
示例值：""

集群状态信息

被如下接口引用：DescribeClusterStatus。

名称类型描述 ClusterId String 集群Id
示例值："cls-xxxx" ClusterState String 集群状态
示例值："Running" ClusterInstanceState String 集群下机器实例的状态
示例值： "AllNormal" ClusterBMonitor Boolean 集群是否开启监控
示例值：false ClusterInitNodeNum Integer 集群创建中的节点数，-1表示获取节点状态超时，-2表示获取节点状态失败
示例值：1 ClusterRunningNodeNum Integer 集群运行中的节点数，-1表示获取节点状态超时，-2表示获取节点状态失败
示例值：3 ClusterFailedNodeNum Integer 集群异常的节点数，-1表示获取节点状态超时，-2表示获取节点状态失败
示例值：0 ClusterClosedNodeNum Integer 集群已关机的节点数，-1表示获取节点状态超时，-2表示获取节点状态失败
注意：此字段可能返回 null，表示取不到有效值。
示例值：0 ClusterClosingNodeNum Integer 集群关机中的节点数，-1表示获取节点状态超时，-2表示获取节点状态失败
注意：此字段可能返回 null，表示取不到有效值。
示例值：0 ClusterDeletionProtection Boolean 集群是否开启删除保护
注意：此字段可能返回 null，表示取不到有效值。
示例值：false ClusterAuditEnabled Boolean 集群是否可审计
注意：此字段可能返回 null，表示取不到有效值。
示例值：false

集群版本信息

被如下接口引用：DescribeAvailableClusterVersion。

名称类型描述 ClusterId String 集群ID Versions Array of String 集群主版本号列表，例如1.18.4

账户UIN与客户端证书CommonName的映射

被如下接口引用：DescribeClusterCommonNames。

名称类型描述 SubaccountUin String 子账户UIN CN String 子账户客户端证书中的CommonName字段

EKS Instance Container容器

被如下接口引用：CreateEKSContainerInstances, DescribeEKSContainerInstances, UpdateEKSContainerInstance。

名称类型必选描述 Image String 是镜像
示例值：… Name String 是容器名
示例值：… Commands Array of String 否容器启动命令
示例值：["sleep"] Args Array of String 否容器启动参数
示例值：["36000"] EnvironmentVars Array of EnvironmentVariable 否容器内操作系统的环境变量
示例值：[] Cpu Float 否 CPU，制改容器最多可使用的核数，该值不可超过容器实例的总核数。单位：核。
示例值：… Memory Float 否内存，限制该容器最多可使用的内存值，该值不可超过容器实例的总内存值。单位：GiB
示例值：… VolumeMounts Array of VolumeMount 否数据卷挂载信息
注意：此字段可能返回 null，表示取不到有效值。
示例值：… CurrentState ContainerState 否当前状态
注意：此字段可能返回 null，表示取不到有效值。
示例值：… RestartCount Integer 否重启次数
注意：此字段可能返回 null，表示取不到有效值。
示例值：… WorkingDir String 否容器工作目录
注意：此字段可能返回 null，表示取不到有效值。
示例值：… LivenessProbe LivenessOrReadinessProbe 否存活探针
注意：此字段可能返回 null，表示取不到有效值。
示例值：… ReadinessProbe LivenessOrReadinessProbe 否就绪探针
注意：此字段可能返回 null，表示取不到有效值。
示例值：… GpuLimit Integer 否 Gpu限制
注意：此字段可能返回 null，表示取不到有效值。
示例值：… SecurityContext SecurityContext 否容器的安全上下文
注意：此字段可能返回 null，表示取不到有效值。
示例值：""

容器状态

被如下接口引用：CreateEKSContainerInstances, UpdateEKSContainerInstance。

名称类型必选描述 StartTime String 否容器运行开始时间
注意：此字段可能返回 null，表示取不到有效值。
示例值：2021-01-22T06:56:09Z State String 否容器状态：created, running, exited, unknown
示例值：running FinishTime String 否容器运行结束时间
注意：此字段可能返回 null，表示取不到有效值。
示例值：2021-01-22T06:56:09Z ExitCode Integer 否容器运行退出码
注意：此字段可能返回 null，表示取不到有效值。
示例值：0 Reason String 否容器状态 Reason
注意：此字段可能返回 null，表示取不到有效值。
示例值：todo Message String 否容器状态信息
注意：此字段可能返回 null，表示取不到有效值。
示例值： todo RestartCount Integer 否容器重启次数
注意：此字段可能返回 null，表示取不到有效值。
示例值： 1

集群中控制器的状态描述

被如下接口引用：DescribeClusterControllers。

名称类型描述 Name String 控制器的名字
示例值：node-ipam-controller Enabled Boolean 控制器是否开启
示例值：true

自定义驱动信息

名称类型必选描述 Address String 否自定义GPU驱动地址链接
注意：此字段可能返回 null，表示取不到有效值。
示例值：https://abc.com/NVIDIA-Linux-x86_64-460.32.03.run

自定义DNS配置

被如下接口引用：CreateEKSContainerInstances。

名称类型必选描述 Nameservers Array of String 否 DNS 服务器IP地址列表
注意：此字段可能返回 null，表示取不到有效值。
示例值：[] Searches Array of String 否 DNS搜索域列表
注意：此字段可能返回 null，表示取不到有效值。
示例值：[] Options Array of DNSConfigOption 否对象选项列表，每个对象由name和value（可选）构成
注意：此字段可能返回 null，表示取不到有效值。
示例值：[]

DNS配置选项

被如下接口引用：CreateEKSContainerInstances。

名称类型必选描述 Name String 是配置项名称
注意：此字段可能返回 null，表示取不到有效值。 Value String 是项值
注意：此字段可能返回 null，表示取不到有效值。

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

被如下接口引用：AddExistedInstances, CreateCluster, CreateClusterInstances, CreateClusterNodePool, DescribeClusterNodePoolDetail, DescribeClusterNodePools, ScaleOutClusterMaster。

名称类型必选描述 DiskType String 是云盘类型
注意：此字段可能返回 null，表示取不到有效值。
示例值：CLOUD_PREMIUM FileSystem String 是文件系统(ext3/ext4/xfs)
注意：此字段可能返回 null，表示取不到有效值。
示例值：ext4 DiskSize Integer 是云盘大小(G）
注意：此字段可能返回 null，表示取不到有效值。
示例值：50 AutoFormatAndMount Boolean 是是否自动化格式盘并挂载
注意：此字段可能返回 null，表示取不到有效值。
示例值：true MountTarget String 是挂载目录
注意：此字段可能返回 null，表示取不到有效值。
示例值：/var/lib/docker DiskPartition String 是挂载设备名或分区名，当且仅当添加已有节点时需要
注意：此字段可能返回 null，表示取不到有效值。
示例值：/dev/vdb

Eks 自定义域名服务器配置

被如下接口引用：CreateEKSCluster, DescribeEKSClusters, UpdateEKSCluster。

名称类型必选描述 Domain String 是域名。空字符串表示所有域名。 DnsServers Array of String 是 dns 服务器地址列表。地址格式 ip:port

GPU驱动和CUDA的版本信息

名称类型必选描述 Version String 是 GPU驱动或者CUDA的版本
注意：此字段可能返回 null，表示取不到有效值。
示例值：418.126.02 Name String 是 GPU驱动或者CUDA的名字
注意：此字段可能返回 null，表示取不到有效值。
示例值：NVIDIA-Linux-x86_64-418.126.02.run

ECM增强服务

被如下接口引用：CreateECMInstances。

名称类型必选描述 SecurityService ECMRunMonitorServiceEnabled 否是否开启云监控服务 MonitorService ECMRunSecurityServiceEnabled 否是否开启云镜服务

ECM云监控服务

被如下接口引用：CreateECMInstances。

名称类型必选描述 Enabled Boolean 否是否开启

ECM云镜服务

被如下接口引用：CreateECMInstances。

名称类型必选描述 Enabled Boolean 否是否开启 Version Integer 否云镜版本：0 基础版，1 专业版

ECM实例可用区及对应的实例创建数目及运营商的组合

被如下接口引用：CreateECMInstances。

名称类型必选描述 Zone String 是创建实例的可用区 InstanceCount Integer 是在当前可用区欲创建的实例数目 ISP String 是运营商

边缘容器参数描述

被如下接口引用：DescribeEdgeAvailableExtraArgs。

名称类型必选描述 Name String 否参数名
注意：此字段可能返回 null，表示取不到有效值。 Type String 否参数类型
注意：此字段可能返回 null，表示取不到有效值。 Usage String 否参数描述
注意：此字段可能返回 null，表示取不到有效值。 Default String 否参数默认值
注意：此字段可能返回 null，表示取不到有效值。 Constraint String 否参数可选范围（目前包含range和in两种，"[]"代表range，如"[1, 5]"表示参数必须>=1且 <=5, "()"代表in，如"(‘aa’, ‘bb’)"表示参数只能为字符串‘aa’或者‘bb’，该参数为空表示不校验）
注意：此字段可能返回 null，表示取不到有效值。

边缘容器集群可用的自定义参数

被如下接口引用：DescribeEdgeAvailableExtraArgs。

名称类型必选描述 KubeAPIServer Array of EdgeArgsFlag 否 kube-apiserver可用的自定义参数
注意：此字段可能返回 null，表示取不到有效值。 KubeControllerManager Array of EdgeArgsFlag 否 kube-controller-manager可用的自定义参数
注意：此字段可能返回 null，表示取不到有效值。 KubeScheduler Array of EdgeArgsFlag 否 kube-scheduler可用的自定义参数
注意：此字段可能返回 null，表示取不到有效值。 Kubelet Array of EdgeArgsFlag 否 kubelet可用的自定义参数
注意：此字段可能返回 null，表示取不到有效值。

边缘计算集群信息

被如下接口引用：DescribeTKEEdgeClusters。

名称类型必选描述 ClusterId String 是集群Id
示例值：cls-xxxxxxxx ClusterName String 是集群名称
示例值：test VpcId String 是 Vpc Id
示例值：vpc-xxxxxxxx PodCIDR String 是集群pod cidr
示例值：10.0.0. ¹⁄ ₁₆ ServiceCIDR String 是集群 service cidr
示例值：10.1.1. ¹⁄ ₁₆ K8SVersion String 是 k8s 版本号
示例值：1.20.6 Status String 否集群状态
示例值：Running ClusterDesc String 否集群描述信息
示例值：test CreatedTime String 否集群创建时间
示例值：2022-08-09 16:54:33 EdgeClusterVersion String 否边缘集群版本
示例值：2.2 MaxNodePodNum Integer 否节点最大Pod数
注意：此字段可能返回 null，表示取不到有效值。
示例值：61 ClusterAdvancedSettings EdgeClusterAdvancedSettings 否集群高级设置
注意：此字段可能返回 null，表示取不到有效值。
示例值：ClusterAdvancedSettings Level String 否边缘容器集群级别
注意：此字段可能返回 null，表示取不到有效值。
示例值：L5 AutoUpgradeClusterLevel Boolean 否是否支持自动提升集群配置
注意：此字段可能返回 null，表示取不到有效值。
示例值：true ChargeType String 否集群付费模式，支持POSTPAID_BY_HOUR或者PREPAID
注意：此字段可能返回 null，表示取不到有效值。
示例值：POSTPAID_BY_HOUR EdgeVersion String 否边缘集群组件的版本
注意：此字段可能返回 null，表示取不到有效值。
示例值：1.9.0 TagSpecification TagSpecification 否集群绑定的云标签
注意：此字段可能返回 null，表示取不到有效值。

边缘容器集群高级配置

被如下接口引用：CreateTKEEdgeCluster, DescribeTKEEdgeClusters。

名称类型必选描述 ExtraArgs EdgeClusterExtraArgs 否集群自定义参数
注意：此字段可能返回 null，表示取不到有效值。
示例值：EdgeClusterExtraArgs Runtime String 否运行时类型，支持"docker"和"containerd"，默认为docker
注意：此字段可能返回 null，表示取不到有效值。
示例值：docker ProxyMode String 否集群kube-proxy转发模式，支持"iptables"和"ipvs"，默认为iptables
注意：此字段可能返回 null，表示取不到有效值。
示例值：iptables

边缘容器集群master自定义参数

被如下接口引用：CreateTKEEdgeCluster, DescribeEdgeClusterExtraArgs, DescribeTKEEdgeClusters。

边缘计算集群内网访问LB信息

被如下接口引用：DescribeTKEEdgeClusterCredential, UpdateTKEEdgeCluster。

名称类型必选描述 Enabled Boolean 是是否开启内网访问LB
注意：此字段可能返回 null，表示取不到有效值。 SubnetId Array of String 否内网访问LB关联的子网Id
注意：此字段可能返回 null，表示取不到有效值。

边缘计算集群公网访问负载均衡信息

被如下接口引用：CreateTKEEdgeCluster, DescribeTKEEdgeClusterCredential, UpdateTKEEdgeCluster。

名称类型必选描述 Enabled Boolean 是是否开启公网访问LB
注意：此字段可能返回 null，表示取不到有效值。 AllowFromCidrs Array of String 否允许访问的公网cidr
注意：此字段可能返回 null，表示取不到有效值。

用以帮助用户自动创建EIP的配置

被如下接口引用：CreateEKSContainerInstances, CreateImageCache。

名称类型必选描述 DeletePolicy String 是容器实例删除后，EIP是否释放。
Never表示不释放，其他任意值（包括空字符串）表示释放。
示例值："" InternetServiceProvider String 否 EIP线路类型。默认值：BGP。
已开通静态单线IP白名单的用户，可选值：
CMCC：中国移动
CTCC：中国电信
CUCC：中国联通
注意：仅部分地域支持静态单线IP。
注意：此字段可能返回 null，表示取不到有效值。
示例值："" InternetMaxBandwidthOut Integer 否 EIP出带宽上限，单位：Mbps。
注意：此字段可能返回 null，表示取不到有效值。
示例值：""

EksContainerInstance实例类型

被如下接口引用：DescribeEKSContainerInstances。

名称类型必选描述 EksCiId String 否 EKS Cotainer Instance Id
示例值：eksci-xxx EksCiName String 否 EKS Cotainer Instance Name
示例值："" Memory Float 否内存大小
示例值："" Cpu Float 否 CPU大小
示例值："" SecurityGroupIds Array of String 否安全组ID
示例值："" RestartPolicy String 否容器组的重启策略
注意：此字段可能返回 null，表示取不到有效值。
示例值："" Status String 否返回容器组创建状态：Pending，Running，Succeeded，Failed。其中：
Failed （运行失败）指的容器组退出，RestartPolilcy为Never，有容器exitCode非0；
Succeeded（运行成功）指的是容器组退出了，RestartPolicy为Never或onFailure，所有容器exitCode都为0；
Failed和Succeeded这两种状态都会停止运行，停止计费。
Pending是创建中，Running是运行中。
注意：此字段可能返回 null，表示取不到有效值。
示例值：Running CreationTime String 否接到请求后的系统创建时间。
注意：此字段可能返回 null，表示取不到有效值。
示例值："" SucceededTime String 否容器全部成功退出后的时间
注意：此字段可能返回 null，表示取不到有效值。
示例值："" Containers Array of Container 否容器列表
注意：此字段可能返回 null，表示取不到有效值。
示例值：[] EksCiVolume EksCiVolume 否数据卷信息
注意：此字段可能返回 null，表示取不到有效值。
示例值：[] SecurityContext SecurityContext 否容器组运行的安全上下文
注意：此字段可能返回 null，表示取不到有效值。
示例值：[] PrivateIp String 否内网ip地址
注意：此字段可能返回 null，表示取不到有效值。
示例值：[] EipAddress String 否容器实例绑定的Eip地址，注意可能为空
注意：此字段可能返回 null，表示取不到有效值。
示例值："" GpuType String 否 GPU类型。如无使用GPU则不返回
注意：此字段可能返回 null，表示取不到有效值。
示例值："" CpuType String 否 CPU类型
注意：此字段可能返回 null，表示取不到有效值。
示例值："" GpuCount Integer 否 GPU卡数量
注意：此字段可能返回 null，表示取不到有效值。
示例值："" VpcId String 否实例所属VPC的Id
注意：此字段可能返回 null，表示取不到有效值。
示例值："" SubnetId String 否实例所属子网Id
注意：此字段可能返回 null，表示取不到有效值。
示例值："" InitContainers Array of Container 否初始化容器列表
注意：此字段可能返回 null，表示取不到有效值。
示例值："" CamRoleName String 否为容器实例关联 CAM 角色，value 填写 CAM 角色名称，容器实例可获取该 CAM 角色包含的权限策略，方便容器实例内的程序进行如购买资源、读写存储等云资源操作。
注意：此字段可能返回 null，表示取不到有效值。
示例值："" AutoCreatedEipId String 否自动为用户创建的EipId
注意：此字段可能返回 null，表示取不到有效值。
示例值："" PersistStatus Boolean 否容器状态是否持久化
注意：此字段可能返回 null，表示取不到有效值。
示例值：""

EksCi地域信息

被如下接口引用：DescribeEKSContainerInstanceRegions。

名称类型描述 Alias String 地域别名，形如gz
示例值："" RegionName String 地域名，形如ap-guangzhou
示例值："" RegionId Integer 地域ID
示例值：""

EKS Instance Volume, 可选包括CbsVolume和NfsVolume

被如下接口引用：CreateEKSContainerInstances, DescribeEKSContainerInstances, UpdateEKSContainerInstance。

名称类型必选描述 CbsVolumes Array of CbsVolume 否 Cbs Volume
注意：此字段可能返回 null，表示取不到有效值。
示例值：[] NfsVolumes Array of NfsVolume 否 Nfs Volume
注意：此字段可能返回 null，表示取不到有效值。
示例值：[]

弹性集群信息

被如下接口引用：DescribeEKSClusters。

名称类型必选描述 ClusterId String 是集群Id
示例值：cls-xxxxxxxx ClusterName String 是集群名称
示例值：xxx VpcId String 是 Vpc Id
示例值：vpc-xxxxxxxx SubnetIds Array of String 是子网列表
示例值：subnet-xxxx K8SVersion String 是 k8s 版本号
示例值：1.16.9 Status String 否集群状态(running运行中，initializing 初始化中，failed异常)
示例值：Running ClusterDesc String 否集群描述信息
示例值：xxxx CreatedTime String 否集群创建时间
示例值：2019-08-16T04:31:26Z ServiceSubnetId String 否 Service 子网Id
示例值：subnet-xxxx DnsServers Array of DnsServerConf 否集群的自定义dns 服务器信息
示例值：{} NeedDeleteCbs Boolean 否将来删除集群时是否要删除cbs。默认为 FALSE
示例值：true EnableVpcCoreDNS Boolean 否是否在用户集群内开启Dns。默认为TRUE
示例值：true TagSpecification Array of TagSpecification 否标签描述列表。
注意：此字段可能返回 null，表示取不到有效值。
示例值：{}

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

被如下接口引用：AddExistedInstances, CreateCluster, ScaleOutClusterMaster, UpgradeClusterInstances。

名称类型必选描述 SecurityService RunSecurityServiceEnabled 否开启云安全服务。若不指定该参数，则默认开启云安全服务。
示例值：true MonitorService RunMonitorServiceEnabled 否开启云监控服务。若不指定该参数，则默认开启云监控服务。
示例值：true AutomationService RunAutomationServiceEnabled 否开启云自动化助手服务（TencentCloud Automation Tools，TAT）。若不指定该参数，则公共镜像默认开启云自动化助手服务，其他镜像默认不开启云自动化助手服务。
示例值：true

EnvironmentVariable

被如下接口引用：CreateEKSContainerInstances, UpdateEKSContainerInstance。

名称类型必选描述 Name String 否 key Value String 否 val

服务事件

被如下接口引用：DescribeEKSContainerInstanceEvent。

名称类型描述 PodName String pod名称 Reason String 事件原因内容 Type String 事件类型 Count Integer 事件出现次数 FirstTimestamp String 事件第一次出现时间 LastTimestamp String 事件最后一次出现时间 Message String 事件内容

探针在容器内执行检测命令参数类型

被如下接口引用：CreateEKSContainerInstances, UpdateEKSContainerInstance。

名称类型必选描述 Commands Array of String 否容器内检测的命令
注意：此字段可能返回 null，表示取不到有效值。
示例值：["ls"]

已经存在的实例信息

被如下接口引用：DescribeExistedInstances。

名称类型描述 Usable Boolean 实例是否支持加入集群(TRUE 可以加入 FALSE 不能加入)。
注意：此字段可能返回 null，表示取不到有效值。
示例值：false UnusableReason String 实例不支持加入的原因。
注意：此字段可能返回 null，表示取不到有效值。 AlreadyInCluster String 实例已经所在的集群ID。
注意：此字段可能返回 null，表示取不到有效值。 InstanceId String 实例ID形如：ins-xxxxxxxx。
示例值：ins-xxxx InstanceName String 实例名称。
注意：此字段可能返回 null，表示取不到有效值。
示例值：xxxx 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，表示取不到有效值。 IPv6Addresses Array of String 实例的IPv6地址。
注意：此字段可能返回 null，表示取不到有效值。
注意：此字段可能返回 null，表示取不到有效值。

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

被如下接口引用：CreateCluster, ScaleOutClusterMaster。

名称类型必选描述 NodeRole String 是节点角色，取值:MASTER_ETCD, WORKER。MASTER_ETCD只有在创建 INDEPENDENT_CLUSTER 独立集群时需要指定。MASTER_ETCD节点数量为3～7，建议为奇数。MASTER_ETCD最小配置为4C8G。
示例值：worker ExistedInstancesPara ExistedInstancesPara 是已存在实例的重装参数 InstanceAdvancedSettingsOverride InstanceAdvancedSettings 否节点高级设置，会覆盖集群级别设置的InstanceAdvancedSettings（当前只对节点自定义参数ExtraArgs生效） DesiredPodNumbers Array of Integer 否自定义模式集群，可指定每个节点的pod数量
示例值：[16,32]

已存在实例的重装参数

被如下接口引用：CreateCluster, ScaleOutClusterMaster。

名称类型必选描述 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一致)

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

被如下接口引用：CreateCluster。

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

修改标签失败的资源

被如下接口引用：DescribeBatchModifyTagsStatus。

名称类型描述 Resource String 资源六段式
注意：此字段可能返回 null，表示取不到有效值。
示例值：qcs::tke: ${region}:uin/${uin}:cluster/ \({ClusterId}</td> </tr> <tr> <td>Error</td> <td>String</td> <td>执行失败的原因<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> </tbody></div> <p>过滤器</p> <p>被如下接口引用：CheckInstancesUpgradeAble, DescribeClusterInstances, DescribeClusterNodePools, DescribeClusterRoutes, DescribeClusters, DescribeECMInstances, DescribeEKSClusters, DescribeEKSContainerInstances, DescribeEdgeCVMInstances, DescribeEdgeClusterInstances, DescribeExistedInstances, DescribeImageCaches, DescribePodsBySpec, DescribePrometheusAlertPolicy, DescribePrometheusAlertRule, DescribePrometheusInstancesOverview, DescribePrometheusOverviews, DescribePrometheusRecordRules, DescribePrometheusTargets, DescribePrometheusTemp, DescribePrometheusTemplates, DescribeRIUtilizationDetail, DescribeReservedInstances, DescribeTKEEdgeClusters。</p> <div> <thead> <tr> <th>名称</th> <th>类型</th> <th>必选</th> <th>描述</th> </tr> </thead> <tbody><tr> <td>Name</td> <td>String</td> <td>是</td> <td>属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。</td> </tr> <tr> <td>Values</td> <td>Array of String</td> <td>是</td> <td>属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。</td> </tr> </tbody></div> <p>GPU相关的参数，包括驱动版本，CUDA版本，cuDNN版本以及是否开启MIG</p> <p>被如下接口引用：AddExistedInstances, CreateCluster, CreateClusterInstances, CreateClusterNodePool, DescribeClusterNodePoolDetail, DescribeClusterNodePools, ModifyClusterNodePool, ScaleOutClusterMaster。</p> <div> <thead> <tr> <th>名称</th> <th>类型</th> <th>必选</th> <th>描述</th> </tr> </thead> <tbody><tr> <td>MIGEnable</td> <td>Boolean</td> <td>否</td> <td>是否启用MIG特性<br>注意：此字段可能返回 null，表示取不到有效值。<br>示例值：false</td> </tr> <tr> <td>Driver</td> <td>DriverVersion</td> <td>否</td> <td>GPU驱动版本信息</td> </tr> <tr> <td>CUDA</td> <td>DriverVersion</td> <td>否</td> <td>CUDA版本信息<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>CUDNN</td> <td>CUDNN</td> <td>否</td> <td>cuDNN版本信息<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>CustomDriver</td> <td>CustomDriver</td> <td>否</td> <td>自定义GPU驱动信息<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> </tbody></div> <p>Probe中的HttpGet</p> <p>被如下接口引用：CreateEKSContainerInstances, UpdateEKSContainerInstance。</p> <div> <thead> <tr> <th>名称</th> <th>类型</th> <th>必选</th> <th>描述</th> </tr> </thead> <tbody><tr> <td>Path</td> <td>String</td> <td>是</td> <td>HttpGet检测的路径<br>注意：此字段可能返回 null，表示取不到有效值。<br>示例值：/</td> </tr> <tr> <td>Port</td> <td>Integer</td> <td>是</td> <td>HttpGet检测的端口号<br>注意：此字段可能返回 null，表示取不到有效值。<br>示例值：80</td> </tr> <tr> <td>Scheme</td> <td>String</td> <td>是</td> <td>HTTP or HTTPS<br>注意：此字段可能返回 null，表示取不到有效值。<br>示例值：HTTP</td> </tr> </tbody></div> <p>IP 地址</p> <p>被如下接口引用：DescribeEKSClusterCredential, DescribeTKEEdgeClusterCredential。</p> <div> <thead> <tr> <th>名称</th> <th>类型</th> <th>必选</th> <th>描述</th> </tr> </thead> <tbody><tr> <td>Type</td> <td>String</td> <td>是</td> <td>Ip 地址的类型。可为 advertise, public 等</td> </tr> <tr> <td>Ip</td> <td>String</td> <td>是</td> <td>Ip 地址</td> </tr> <tr> <td>Port</td> <td>Integer</td> <td>是</td> <td>网络端口</td> </tr> </tbody></div> <p>镜像缓存的信息</p> <p>被如下接口引用：DescribeImageCaches, GetMostSuitableImageCache。</p> <div> <thead> <tr> <th>名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody><tr> <td>ImageCacheId</td> <td>String</td> <td>镜像缓存Id<br>示例值：""</td> </tr> <tr> <td>ImageCacheName</td> <td>String</td> <td>镜像缓存名称<br>示例值：""</td> </tr> <tr> <td>ImageCacheSize</td> <td>Integer</td> <td>镜像缓存大小。单位：GiB<br>示例值：""</td> </tr> <tr> <td>Images</td> <td>Array of String</td> <td>镜像缓存包含的镜像列表<br>示例值：""</td> </tr> <tr> <td>CreationTime</td> <td>String</td> <td>创建时间<br>示例值：""</td> </tr> <tr> <td>ExpireDateTime</td> <td>String</td> <td>到期时间<br>示例值：""</td> </tr> <tr> <td>Events</td> <td>Array of ImageCacheEvent</td> <td>镜像缓存事件信息<br>示例值：""</td> </tr> <tr> <td>LastMatchedTime</td> <td>String</td> <td>最新一次匹配到镜像缓存的时间<br>示例值：""</td> </tr> <tr> <td>SnapshotId</td> <td>String</td> <td>镜像缓存对应的快照Id<br>示例值：""</td> </tr> <tr> <td>Status</td> <td>String</td> <td>镜像缓存状态，可能取值：<br>Pending：创建中<br>Ready：创建完成<br>Failed：创建失败<br>Updating：更新中<br>UpdateFailed：更新失败<br>只有状态为Ready时，才能正常使用镜像缓存<br>示例值：""</td> </tr> </tbody></div> <p>镜像缓存的事件</p> <p>被如下接口引用：DescribeImageCaches, GetMostSuitableImageCache。</p> <div> <thead> <tr> <th>名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody><tr> <td>ImageCacheId</td> <td>String</td> <td>镜像缓存Id<br>示例值：""</td> </tr> <tr> <td>Type</td> <td>String</td> <td>事件类型, Normal或者Warning<br>示例值：""</td> </tr> <tr> <td>Reason</td> <td>String</td> <td>事件原因简述<br>示例值：""</td> </tr> <tr> <td>Message</td> <td>String</td> <td>事件原因详述<br>示例值：""</td> </tr> <tr> <td>FirstTimestamp</td> <td>String</td> <td>事件第一次出现时间<br>示例值：""</td> </tr> <tr> <td>LastTimestamp</td> <td>String</td> <td>事件最后一次出现时间<br>示例值：""</td> </tr> </tbody></div> <p>镜像信息</p> <p>被如下接口引用：DescribeImages。</p> <div> <thead> <tr> <th>名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody><tr> <td>Alias</td> <td>String</td> <td>镜像别名<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>OsName</td> <td>String</td> <td>操作系统名称<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>ImageId</td> <td>String</td> <td>镜像ID<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>OsCustomizeType</td> <td>String</td> <td>容器的镜像版本，"DOCKER_CUSTOMIZE"(容器定制版),"GENERAL"(普通版本，默认值)<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> </tbody></div> <p>从镜像仓库拉取镜像的凭据</p> <p>被如下接口引用：CreateEKSContainerInstances, CreateImageCache, UpdateEKSContainerInstance, UpdateImageCache。</p> <div> <thead> <tr> <th>名称</th> <th>类型</th> <th>必选</th> <th>描述</th> </tr> </thead> <tbody><tr> <td>Server</td> <td>String</td> <td>否</td> <td>镜像仓库地址<br>示例值：""</td> </tr> <tr> <td>Username</td> <td>String</td> <td>否</td> <td>用户名<br>示例值：""</td> </tr> <tr> <td>Password</td> <td>String</td> <td>否</td> <td>密码<br>示例值：""</td> </tr> <tr> <td>Name</td> <td>String</td> <td>否</td> <td>ImageRegistryCredential的名字<br>示例值：""</td> </tr> </tbody></div> <p>集群的实例信息</p> <p>被如下接口引用：DescribeClusterInstances。</p> <div> <thead> <tr> <th>名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody><tr> <td>InstanceId</td> <td>String</td> <td>实例ID<br>示例值：ins-xxxxxx</td> </tr> <tr> <td>InstanceRole</td> <td>String</td> <td>节点角色, MASTER, WORKER, ETCD, MASTER_ETCD,ALL, 默认为WORKER<br>示例值：WORKER</td> </tr> <tr> <td>FailedReason</td> <td>String</td> <td>实例异常(或者处于初始化中)的原因<br>示例值：=Ready:True</td> </tr> <tr> <td>InstanceState</td> <td>String</td> <td>实例的状态（running 运行中，initializing 初始化中，failed 异常）<br>示例值：running</td> </tr> <tr> <td>DrainStatus</td> <td>String</td> <td>实例是否封锁状态<br>注意：此字段可能返回 null，表示取不到有效值。<br>示例值：drained</td> </tr> <tr> <td>InstanceAdvancedSettings</td> <td>InstanceAdvancedSettings</td> <td>节点配置<br>注意：此字段可能返回 null，表示取不到有效值。<br>示例值：{"MountTarget":"","DataDiskPartition":null,"DockerGraphPath":"",</td> </tr> <tr> <td>CreatedTime</td> <td>String</td> <td>添加时间<br>示例值：2021-02-22T07:14:11Z</td> </tr> <tr> <td>LanIP</td> <td>String</td> <td>节点内网IP<br>注意：此字段可能返回 null，表示取不到有效值。<br>示例值：null</td> </tr> <tr> <td>NodePoolId</td> <td>String</td> <td>资源池ID<br>注意：此字段可能返回 null，表示取不到有效值。<br>示例值：np-xxxxxxxx</td> </tr> <tr> <td>AutoscalingGroupId</td> <td>String</td> <td>自动伸缩组ID<br>注意：此字段可能返回 null，表示取不到有效值。<br>示例值：asg-xxxxxxxx</td> </tr> </tbody></div> <p>描述了k8s集群相关配置与信息。</p> <p>被如下接口引用：AddExistedInstances, CreateCluster, CreateClusterInstances, CreateClusterNodePool, DescribeClusterInstances, ScaleOutClusterMaster, UpgradeClusterInstances。</p> <div> <thead> <tr> <th>名称</th> <th>类型</th> <th>必选</th> <th>描述</th> </tr> </thead> <tbody><tr> <td>DesiredPodNumber</td> <td>Integer</td> <td>是</td> <td>该节点属于podCIDR大小自定义模式时，可指定节点上运行的pod数量上限<br>注意：此字段可能返回 null，表示取不到有效值。<br>示例值：16</td> </tr> <tr> <td>GPUArgs</td> <td>GPUArgs</td> <td>是</td> <td>GPU驱动相关参数,相关的GPU参数获取:https://cloud.tencent.com/document/api/213/15715<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>PreStartUserScript</td> <td>String</td> <td>是</td> <td>base64 编码的用户脚本，在初始化节点之前执行，目前只对添加已有节点生效<br>注意：此字段可能返回 null，表示取不到有效值。<br>示例值：#!/bin/sh echo "hello world"</td> </tr> <tr> <td>Taints</td> <td>Array of Taint</td> <td>是</td> <td>节点污点<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>MountTarget</td> <td>String</td> <td>否</td> <td>数据盘挂载点, 默认不挂载数据盘. 已格式化的 ext3，ext4，xfs 文件系统的数据盘将直接挂载，其他文件系统或未格式化的数据盘将自动格式化为ext4 (tlinux系统格式化成xfs)并挂载，请注意备份数据! 无数据盘或有多块数据盘的云主机此设置不生效。<br>注意，注意，多盘场景请使用下方的DataDisks数据结构，设置对应的云盘类型、云盘大小、挂载路径、是否格式化等信息。<br>注意：此字段可能返回 null，表示取不到有效值。<br>示例值：/tmp</td> </tr> <tr> <td>DockerGraphPath</td> <td>String</td> <td>否</td> <td>dockerd --graph 指定值, 默认为 /var/lib/docker<br>注意：此字段可能返回 null，表示取不到有效值。<br>示例值：/var/lib/docker</td> </tr> <tr> <td>UserScript</td> <td>String</td> <td>否</td> <td>base64 编码的用户脚本, 此脚本会在 k8s 组件运行后执行, 需要用户保证脚本的可重入及重试逻辑, 脚本及其生成的日志文件可在节点的 /data/ccs_userscript/ 路径查看, 如果要求节点需要在进行初始化完成后才可加入调度, 可配合 unschedulable 参数使用, 在 userScript 最后初始化完成后, 添加 kubectl uncordon nodename --kubeconfig=/root/.kube/config 命令使节点加入调度<br>注意：此字段可能返回 null，表示取不到有效值。<br>示例值：#!/bin/sh echo "hello world"</td> </tr> <tr> <td>Unschedulable</td> <td>Integer</td> <td>否</td> <td>设置加入的节点是否参与调度，默认值为0，表示参与调度；非0表示不参与调度, 待节点初始化完成之后, 可执行kubectl uncordon nodename使node加入调度.<br>示例值：false</td> </tr> <tr> <td>Labels</td> <td>Array of Label</td> <td>否</td> <td>节点Label数组<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>DataDisks</td> <td>Array of DataDisk</td> <td>否</td> <td>多盘数据盘挂载信息：新建节点时请确保购买CVM的参数传递了购买多个数据盘的信息，如CreateClusterInstances API的RunInstancesPara下的DataDisks也需要设置购买多个数据盘, 具体可以参考CreateClusterInstances接口的添加集群节点(多块数据盘)样例；添加已有节点时，请确保填写的分区信息在节点上真实存在<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>ExtraArgs</td> <td>InstanceExtraArgs</td> <td>否</td> <td>节点相关的自定义参数信息<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> </tbody></div> <p>包年包月配置</p> <p>被如下接口引用：CreateReservedInstances, RenewReservedInstances。</p> <div> <thead> <tr> <th>名称</th> <th>类型</th> <th>必选</th> <th>描述</th> </tr> </thead> <tbody><tr> <td>Period</td> <td>Integer</td> <td>是</td> <td>购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60。<br>示例值：1</td> </tr> <tr> <td>RenewFlag</td> <td>String</td> <td>否</td> <td>自动续费标识。取值范围：<br>NOTIFY_AND_AUTO_RENEW：通知过期且自动续费<br>NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费<br>DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费<br><br>默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。<br>示例值：NOTIFY_AND_MANUAL_RENEW</td> </tr> </tbody></div> <p>CVM实例数据盘挂载配置</p> <p>被如下接口引用：CreateCluster。</p> <div> <thead> <tr> <th>名称</th> <th>类型</th> <th>必选</th> <th>描述</th> </tr> </thead> <tbody><tr> <td>InstanceType</td> <td>String</td> <td>是</td> <td>CVM实例类型</td> </tr> <tr> <td>DataDisks</td> <td>Array of DataDisk</td> <td>是</td> <td>数据盘挂载信息</td> </tr> <tr> <td>Zone</td> <td>String</td> <td>是</td> <td>CVM实例所属可用区</td> </tr> </tbody></div> <p>节点自定义参数</p> <p>被如下接口引用：AddExistedInstances, CreateCluster, CreateClusterInstances, CreateClusterNodePool, DescribeClusterNodePoolDetail, DescribeClusterNodePools, ModifyClusterNodePool, ScaleOutClusterMaster。</p> <div> <thead> <tr> <th>名称</th> <th>类型</th> <th>必选</th> <th>描述</th> </tr> </thead> <tbody><tr> <td>Kubelet</td> <td>Array of String</td> <td>否</td> <td>kubelet自定义参数，参数格式为["k1=v1", "k1=v2"]，例如["root-dir=/var/lib/kubelet","feature-gates=PodShareProcessNamespace=true,DynamicKubeletConfig=true"]<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> </tbody></div> <p>节点升级过程中集群当前状态</p> <p>被如下接口引用：GetUpgradeInstanceProgress。</p> <div> <thead> <tr> <th>名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody><tr> <td>PodTotal</td> <td>Integer</td> <td>pod总数</td> </tr> <tr> <td>NotReadyPod</td> <td>Integer</td> <td>NotReady pod总数</td> </tr> </tbody></div> <p>某个节点升级前检查结果</p> <p>被如下接口引用：GetUpgradeInstanceProgress。</p> <div> <thead> <tr> <th>名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody><tr> <td>CheckPass</td> <td>Boolean</td> <td>检查是否通过</td> </tr> <tr> <td>Items</td> <td>Array of InstanceUpgradePreCheckResultItem</td> <td>检查项数组</td> </tr> <tr> <td>SinglePods</td> <td>Array of String</td> <td>本节点独立pod列表</td> </tr> </tbody></div> <p>节点升级检查项结果</p> <p>被如下接口引用：GetUpgradeInstanceProgress。</p> <div> <thead> <tr> <th>名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody><tr> <td>Namespace</td> <td>String</td> <td>工作负载的命名空间</td> </tr> <tr> <td>WorkLoadKind</td> <td>String</td> <td>工作负载类型</td> </tr> <tr> <td>WorkLoadName</td> <td>String</td> <td>工作负载名称</td> </tr> <tr> <td>Before</td> <td>Integer</td> <td>驱逐节点前工作负载running的pod数目</td> </tr> <tr> <td>After</td> <td>Integer</td> <td>驱逐节点后工作负载running的pod数目</td> </tr> <tr> <td>Pods</td> <td>Array of String</td> <td>工作负载在本节点上的pod列表</td> </tr> </tbody></div> <p>某个节点的升级进度</p> <p>被如下接口引用：GetUpgradeInstanceProgress。</p> <div> <thead> <tr> <th>名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody><tr> <td>InstanceID</td> <td>String</td> <td>节点instanceID</td> </tr> <tr> <td>LifeState</td> <td>String</td> <td>任务生命周期<br>process 运行中<br>paused 已停止<br>pauing 正在停止<br>done 已完成<br>timeout 已超时<br>aborted 已取消<br>pending 还未开始</td> </tr> <tr> <td>StartAt</td> <td>String</td> <td>升级开始时间<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>EndAt</td> <td>String</td> <td>升级结束时间<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>CheckResult</td> <td>InstanceUpgradePreCheckResult</td> <td>升级前检查结果</td> </tr> <tr> <td>Detail</td> <td>Array of TaskStepInfo</td> <td>升级步骤详情</td> </tr> </tbody></div> <p>kms加密参数</p> <p>被如下接口引用：EnableEncryptionProtection。</p> <div> <thead> <tr> <th>名称</th> <th>类型</th> <th>必选</th> <th>描述</th> </tr> </thead> <tbody><tr> <td>KeyId</td> <td>String</td> <td>否</td> <td>kms id<br>示例值：38098f4c-f5ef-11ed-8c28-b4ad52</td> </tr> <tr> <td>KmsRegion</td> <td>String</td> <td>否</td> <td>kms 地域<br>示例值：ap-guangzhou</td> </tr> </tbody></div> <p>集群巡检诊断的默认目录类型</p> <p>被如下接口引用：DescribeClusterInspectionResultsOverview, ListClusterInspectionResults。</p> <div> <thead> <tr> <th>名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody><tr> <td>CatalogueLevel</td> <td>String</td> <td>目录级别，支持参数：<br>first：一级目录<br>second：二级目录<br>注意：此字段可能返回 null，表示取不到有效值。<br>示例值：first</td> </tr> <tr> <td>CatalogueName</td> <td>String</td> <td>目录名<br>注意：此字段可能返回 null，表示取不到有效值。<br>示例值：quota</td> </tr> </tbody></div> <p>集群巡检诊断结果</p> <p>被如下接口引用：ListClusterInspectionResults。</p> <div> <thead> <tr> <th>名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody><tr> <td>StartTime</td> <td>String</td> <td>诊断开始时间<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>EndTime</td> <td>String</td> <td>诊断结束时间<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>Catalogues</td> <td>Array of KubeJarvisStateCatalogue</td> <td>诊断目录<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>Type</td> <td>String</td> <td>诊断类型<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>Name</td> <td>String</td> <td>诊断名称<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>Desc</td> <td>String</td> <td>诊断描述<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>Results</td> <td>Array of KubeJarvisStateResultsItem</td> <td>诊断结果列表<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>Statistics</td> <td>Array of KubeJarvisStateStatistic</td> <td>诊断结果统计<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> </tbody></div> <p>集群巡检诊断概览</p> <p>被如下接口引用：DescribeClusterInspectionResultsOverview。</p> <div> <thead> <tr> <th>名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody><tr> <td>Catalogues</td> <td>Array of KubeJarvisStateCatalogue</td> <td>诊断目录<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>Statistics</td> <td>Array of KubeJarvisStateStatistic</td> <td>诊断结果统计<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> </tbody></div> <p>集群巡检检查结果概览</p> <p>被如下接口引用：DescribeClusterInspectionResultsOverview。</p> <div> <thead> <tr> <th>名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody><tr> <td>ClusterId</td> <td>String</td> <td>集群ID<br>注意：此字段可能返回 null，表示取不到有效值。<br>示例值：cls-dsffsd</td> </tr> <tr> <td>Statistics</td> <td>Array of KubeJarvisStateStatistic</td> <td>诊断结果统计<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>Diagnostics</td> <td>Array of KubeJarvisStateDiagnosticOverview</td> <td>诊断结果详情<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> </tbody></div> <p>集群巡检检查结果</p> <p>被如下接口引用：ListClusterInspectionResults。</p> <div> <thead> <tr> <th>名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody><tr> <td>ClusterId</td> <td>String</td> <td>集群ID<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>StartTime</td> <td>String</td> <td>诊断开始时间<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>EndTime</td> <td>String</td> <td>诊断结束时间<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>Statistics</td> <td>Array of KubeJarvisStateStatistic</td> <td>诊断结果统计<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>Diagnostics</td> <td>Array of KubeJarvisStateDiagnostic</td> <td>诊断结果详情<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>Error</td> <td>String</td> <td>查询巡检报告相关报错<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> </tbody></div> <p>集群巡检结果历史列表</p> <p>被如下接口引用：ListClusterInspectionResultsItems。</p> <div> <thead> <tr> <th>名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody><tr> <td>Name</td> <td>String</td> <td>巡检结果名称<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>Statistics</td> <td>Array of KubeJarvisStateStatistic</td> <td>诊断结果统计<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> </tbody></div> <p>集群巡检诊断对象信息</p> <p>被如下接口引用：ListClusterInspectionResults。</p> <div> <thead> <tr> <th>名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody><tr> <td>PropertyName</td> <td>String</td> <td>对象属性名称<br>注意：此字段可能返回 null，表示取不到有效值。<br>示例值：Name</td> </tr> <tr> <td>PropertyValue</td> <td>String</td> <td>对象属性值<br>注意：此字段可能返回 null，表示取不到有效值。<br>示例值：pod-test</td> </tr> </tbody></div> <p>集群巡检诊断结果详情信息</p> <p>被如下接口引用：ListClusterInspectionResults。</p> <div> <thead> <tr> <th>名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody><tr> <td>Level</td> <td>String</td> <td>诊断结果级别<br>注意：此字段可能返回 null，表示取不到有效值。<br>示例值：failed</td> </tr> <tr> <td>ObjName</td> <td>String</td> <td>诊断对象名<br>注意：此字段可能返回 null，表示取不到有效值。<br>示例值：pod-xxx</td> </tr> <tr> <td>ObjInfo</td> <td>Array of KubeJarvisStateResultObjInfo</td> <td>诊断对象信息<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>Title</td> <td>String</td> <td>诊断项标题<br>注意：此字段可能返回 null，表示取不到有效值。<br>示例值：Master Capacity Check</td> </tr> <tr> <td>Desc</td> <td>String</td> <td>诊断项描述<br>注意：此字段可能返回 null，表示取不到有效值。<br>示例值：Master Capacity Check</td> </tr> <tr> <td>Proposal</td> <td>String</td> <td>诊断建议<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>ProposalDocUrl</td> <td>String</td> <td>诊断建议文档链接<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>ProposalDocName</td> <td>String</td> <td>诊断建议文档名称<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> </tbody></div> <p>集群巡检统计结果</p> <p>被如下接口引用：DescribeClusterInspectionResultsOverview, ListClusterInspectionResults, ListClusterInspectionResultsItems。</p> <div> <thead> <tr> <th>名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody><tr> <td>HealthyLevel</td> <td>String</td> <td>诊断结果的健康水平<br>注意：此字段可能返回 null，表示取不到有效值。<br>示例值：good</td> </tr> <tr> <td>Count</td> <td>Integer</td> <td>诊断结果的统计<br>注意：此字段可能返回 null，表示取不到有效值。<br>示例值：2</td> </tr> </tbody></div> <p>k8s中标签，一般以数组的方式存在</p> <p>被如下接口引用：AddExistedInstances, CreateCluster, CreateClusterInstances, CreateClusterNodePool, CreateClusterVirtualNodePool, CreatePrometheusAlertPolicy, CreatePrometheusAlertRule, CreatePrometheusClusterAgent, CreatePrometheusTemplate, DescribeClusterAsGroups, DescribeClusterNodePoolDetail, DescribeClusterNodePools, DescribeClusterVirtualNodePools, DescribePrometheusAgents, DescribePrometheusAlertPolicy, DescribePrometheusAlertRule, DescribePrometheusClusterAgents, DescribePrometheusTargets, DescribePrometheusTemplates, ModifyClusterNodePool, ModifyClusterVirtualNodePool, ModifyPrometheusAgentExternalLabels, ModifyPrometheusAlertPolicy, ModifyPrometheusAlertRule, ModifyPrometheusTemp, ModifyPrometheusTemplate, ScaleOutClusterMaster。</p> <div> <thead> <tr> <th>名称</th> <th>类型</th> <th>必选</th> <th>描述</th> </tr> </thead> <tbody><tr> <td>Name</td> <td>String</td> <td>是</td> <td>map表中的Name</td> </tr> <tr> <td>Value</td> <td>String</td> <td>是</td> <td>map表中的Value</td> </tr> </tbody></div> <p>健康探针</p> <p>被如下接口引用：CreateEKSContainerInstances, UpdateEKSContainerInstance。</p> <div> <thead> <tr> <th>名称</th> <th>类型</th> <th>必选</th> <th>描述</th> </tr> </thead> <tbody><tr> <td>Probe</td> <td>Probe</td> <td>是</td> <td>探针参数<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>HttpGet</td> <td>HttpGet</td> <td>否</td> <td>HttpGet检测参数<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>Exec</td> <td>Exec</td> <td>否</td> <td>容器内检测命令参数<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> <tr> <td>TcpSocket</td> <td>TcpSocket</td> <td>否</td> <td>TcpSocket检测的端口参数<br>注意：此字段可能返回 null，表示取不到有效值。</td> </tr> </tbody></div> <p>描述了实例登录相关配置与信息。</p> <p>被如下接口引用：AddExistedInstances, CreateCluster, ScaleOutClusterMaster, UpgradeClusterInstances。</p> <div> <thead> <tr> <th>名称</th> <th>类型</th> <th>必选</th> <th>描述</th> </tr> </thead> <tbody><tr> <td>Password</td> <td>String</td> <td>否</td> <td>实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下：<li>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，表示取不到有效值。
示例值：["skey-3glfot13"] KeepImageLogin String 否保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为true。取值范围：

true：表示保持镜像的登录设置

false：表示不保持镜像的登录设置

默认取值：false。
注意：此字段可能返回 null，表示取不到有效值。
示例值：abc

手动加入的节点

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

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

EKS Instance Nfs Volume

被如下接口引用：CreateEKSContainerInstances, UpdateEKSContainerInstance。

名称类型必选描述 Name String 是 nfs volume 数据卷名称
示例值：[] Server String 是 NFS 服务器地址
示例值：[] Path String 是 NFS 数据卷路径
示例值：[] ReadOnly Boolean 否默认为 False
示例值：[]

节点统计列表

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

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

节点池描述

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

名称类型描述 NodePoolId String NodePoolId 资源池id
示例值：np-xxx Name String Name 资源池名称
示例值：xxx ClusterInstanceId String ClusterInstanceId 集群实例id
示例值：cls-xxx LifeState String LifeState 状态，当前节点池生命周期状态包括：creating，normal，updating，deleting，deleted
示例值：normal LaunchConfigurationId String LaunchConfigurationId 配置
示例值：asc-xxx AutoscalingGroupId String AutoscalingGroupId 分组id
示例值：asg-xxx Labels Array of Label Labels 标签 Taints Array of Taint Taints 污点标记 Annotations Array of AnnotationValue 节点 Annotation 列表
示例值：[] 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 RuntimeConfig RuntimeConfig 运行时描述
注意：此字段可能返回 null，表示取不到有效值。
示例值：{"RuntimeType":"","RuntimeVersion":""} NodePoolOs String 节点池osName
注意：此字段可能返回 null，表示取不到有效值。
示例值：tlinux2.4x86_64 OsCustomizeType String 容器的镜像版本，"DOCKER_CUSTOMIZE"(容器定制版),"GENERAL"(普通版本，默认值)
注意：此字段可能返回 null，表示取不到有效值。
示例值：GENERAL ImageId String 镜像id
注意：此字段可能返回 null，表示取不到有效值。
示例值：img-xxx DesiredPodNum Integer 集群属于节点podCIDR大小自定义模式时，节点池需要带上pod数量属性
注意：此字段可能返回 null，表示取不到有效值。
示例值：16 UserScript String 用户自定义脚本
注意：此字段可能返回 null，表示取不到有效值。 Tags Array of Tag 资源标签
注意：此字段可能返回 null，表示取不到有效值。 DeletionProtection Boolean 删除保护开关
注意：此字段可能返回 null，表示取不到有效值。
示例值：false ExtraArgs InstanceExtraArgs 节点配置
注意：此字段可能返回 null，表示取不到有效值。
示例值：{"MountTarget":"","DataDiskPartition":null,"DockerGraphPath":"", GPUArgs GPUArgs GPU驱动相关参数
注意：此字段可能返回 null，表示取不到有效值。 DockerGraphPath String dockerd –graph 指定值, 默认为 /var/lib/docker
注意：此字段可能返回 null，表示取不到有效值。
示例值：/var/lib/docker DataDisks Array of DataDisk 多盘数据盘挂载信息：新建节点时请确保购买CVM的参数传递了购买多个数据盘的信息，如CreateClusterInstances API的RunInstancesPara下的DataDisks也需要设置购买多个数据盘, 具体可以参考CreateClusterInstances接口的添加集群节点(多块数据盘)样例；添加已有节点时，请确保填写的分区信息在节点上真实存在
注意：此字段可能返回 null，表示取不到有效值。 Unschedulable Integer 是否不可调度
注意：此字段可能返回 null，表示取不到有效值。
示例值：0 PreStartUserScript String 用户自定义脚本,在UserScript前执行
注意：此字段可能返回 null，表示取不到有效值。

加入存量节点时的节点池选项

被如下接口引用：AddExistedInstances。

名称类型必选描述 AddToNodePool Boolean 否是否加入节点池 NodePoolId String 否节点池id InheritConfigurationFromNodePool Boolean 否是否继承节点池相关配置

NodePool的运行时配置

被如下接口引用：ModifyClusterRuntimeConfig。

名称类型必选描述 NodePoolId String 否节点池ID
注意：此字段可能返回 null，表示取不到有效值。 RuntimeType String 否运行时类型
注意：此字段可能返回 null，表示取不到有效值。 RuntimeVersion String 否运行时版本
注意：此字段可能返回 null，表示取不到有效值。 NodePoolName String 否节点池名称
注意：此字段可能返回 null，表示取不到有效值。

OIDC认证相关配置

被如下接口引用：DescribeClusterAuthenticationOptions, ModifyClusterAuthenticationOptions。

名称类型必选描述 AutoCreateOIDCConfig Boolean 否创建身份提供商
注意：此字段可能返回 null，表示取不到有效值。
示例值：false AutoCreateClientId Array of String 否创建身份提供商的ClientId
注意：此字段可能返回 null，表示取不到有效值。
示例值：["xxxx","yyyy"] AutoInstallPodIdentityWebhookAddon Boolean 否创建PodIdentityWebhook组件
注意：此字段可能返回 null，表示取不到有效值。
示例值：false

策略实例信息

被如下接口引用：DescribeOpenPolicyList, ModifyOpenPolicyList。

名称类型必选描述 Name String 否策略实例名称
注意：此字段可能返回 null，表示取不到有效值。
示例值：block-namespace-deletion-rule EventNums Integer 否策略实例关联事件数
注意：此字段可能返回 null，表示取不到有效值。
示例值：3 YamlDetail String 否实例yaml详情base64编码
注意：此字段可能返回 null，表示取不到有效值。
示例值：apiVersion: constraints.gatekeeper.sh/v1beta1 kind: BlockNamespaceDeletion metadata: name: block-namespace-deletion-rule annotations: "helm.sh/hook": post-install,post-upgrade spec: enforcementAction: dryrun match: kinds: - apiGroups: ["*"] kinds: ["Namespace"]

opa策略信息

被如下接口引用：DescribeOpenPolicyList。

名称类型描述 PolicyCategory String 策略分类：cluster集群策略、node节点策略、namespace命名空间策略、configuration配置相关策略、compute计算资源策略、storage存储资源策略、network网络资源策略
注意：此字段可能返回 null，表示取不到有效值。
示例值：cluster PolicyName String 策略中文名称
注意：此字段可能返回 null，表示取不到有效值。
示例值：存在节点的集群不允许删除 PolicyDesc String 策略描述
注意：此字段可能返回 null，表示取不到有效值。
示例值：集群中存在任意节点，需下线节点后方可删除 EnforcementAction String 策略运行模式：dryrun空跑不生效，deny拦截生效
注意：此字段可能返回 null，表示取不到有效值。
示例值：dryrun EventNums Integer 关联的事件数量(最近7d)
注意：此字段可能返回 null，表示取不到有效值。
示例值：3 Name String 策略英文名称
注意：此字段可能返回 null，表示取不到有效值。
示例值：block-crd-deletion-rule Kind String 策略模板类型
注意：此字段可能返回 null，表示取不到有效值。
示例值：BlockCrdDeletion EnabledStatus String 策略开关状态：open打开，close关闭
注意：此字段可能返回 null，表示取不到有效值。
示例值：open ConstraintYamlExample String 策略的实例的yaml示例base64编码
注意：此字段可能返回 null，表示取不到有效值。 OpenConstraintInfoList Array of OpenConstraintInfo 策略关联的实例列表
注意：此字段可能返回 null，表示取不到有效值。
示例值：[]

opa策略开关

被如下接口引用：ModifyOpenPolicyList。

名称类型必选描述 EnforcementAction String 是策略运行模式：dryrun空跑不生效，deny拦截生效
示例值：dryrun Name String 是策略英文名称
示例值：block-crd-deletion-rule Kind String 是策略模板类型
示例值：BlockCrdDeletion EnabledStatus String 否策略开关状态：open打开，close关闭
示例值：open OpenConstraintInfoList Array of OpenConstraintInfo 否策略关联的实例列表
示例值：[]

可选运行时

被如下接口引用：DescribeSupportedRuntime。

讯享网

名称类型必选描述 RuntimeType String 否运行时类型
注意：此字段可能返回 null，表示取不到有效值。
示例值：containerd RuntimeVersions Array of String 否运行时版本列表
注意：此字段可能返回 null，表示取不到有效值。
示例值：[ "1.3.4","1.4.3"] DefaultVersion String 否该类型的默认运行时版本
注意：此字段可能返回 null，表示取不到有效值。
示例值：1.3.4

应用市场安装的Pending应用

被如下接口引用：CancelClusterRelease, CreateClusterRelease, DescribeClusterPendingReleases, RollbackClusterRelease, UninstallClusterRelease, UpgradeClusterRelease。

名称类型描述 Condition String 应用状态详情
注意：此字段可能返回 null，表示取不到有效值。 CreatedTime Timestamp ISO8601 创建时间
注意：此字段可能返回 null，表示取不到有效值。 ID String 应用ID
注意：此字段可能返回 null，表示取不到有效值。 Name String 应用名称
注意：此字段可能返回 null，表示取不到有效值。 Namespace String 应用命名空间
注意：此字段可能返回 null，表示取不到有效值。 Status String 应用状态(参考helm的发布状态： unknown, deployed, uninstalled, superseded, failed, uninstalling, pending-install, pending-upgrade 或 pending-rollback)
注意：此字段可能返回 null，表示取不到有效值。 UpdatedTime String 更新时间
注意：此字段可能返回 null，表示取不到有效值。

Pod计费信息

被如下接口引用：DescribePodChargeInfo。

名称类型描述 StartTime String Pod计费开始时间
示例值："2021-07-13 23:06:43" Uid String Pod的Uid
示例值："-ba21-4d03-8e18-33792a647a26" Cpu Float Pod的CPU
示例值：1 Memory Float Pod的内存
示例值：2 Type String Pod类型：intel、amd、v100、t4、a10*gnv4、a10*gnv4v等。
示例值：intel Gpu String Pod是GPU时，表示GPU卡数
注意：此字段可能返回 null，表示取不到有效值。
示例值："0.25" ChargeType String 计费类型
PREPAID：Pod调度到包月超级节点
POSTPAID_BY_HOUR：按量计费
RESERVED_INSTANCE：上个周期被预留券抵扣
SPOT：竞价实例
TPOD：特惠实例
示例值：POSTPAID_BY_HOUR Namespace String 命名空间 Name String Pod名称

可被预留券抵扣的 Pod 某种规格的抵扣率

被如下接口引用：DescribePodDeductionRate。

名称类型描述 Cpu Float Pod的 CPU
注意：此字段可能返回 null，表示取不到有效值。
示例值：1 Memory Float Pod 的内存
注意：此字段可能返回 null，表示取不到有效值。
示例值：2 Type String Pod 的类型
注意：此字段可能返回 null，表示取不到有效值。
示例值：intel GpuNum String Pod 的 GPU 卡数，Pod 类型为 GPU 时有效。
注意：此字段可能返回 null，表示取不到有效值。
示例值："" TotalNum Integer 这种规格的 Pod总数
注意：此字段可能返回 null，表示取不到有效值。
示例值：1 DeductionNum Integer 这种规格的 Pod被预留券抵扣的数量
注意：此字段可能返回 null，表示取不到有效值。
示例值：1

某机型可支持的最大 VPC-CNI 模式的 Pod 数量

被如下接口引用：DescribeVpcCniPodLimits。

名称类型描述 TKERouteENINonStaticIP Integer TKE共享网卡非固定IP模式可支持的Pod数量
注意：此字段可能返回 null，表示取不到有效值。
示例值：27 TKERouteENIStaticIP Integer TKE共享网卡固定IP模式可支持的Pod数量
注意：此字段可能返回 null，表示取不到有效值。
示例值：27 TKEDirectENI Integer TKE独立网卡模式可支持的Pod数量
注意：此字段可能返回 null，表示取不到有效值。
示例值：5 TKESubENI Integer TKE中继网卡模式可支持的Pod数量
注意：此字段可能返回 null，表示取不到有效值。
示例值：100

机型信息和其可支持的最大VPC-CNI模式Pod数量信息

被如下接口引用：DescribeVpcCniPodLimits。

名称类型描述 Zone String 机型所在可用区
注意：此字段可能返回 null，表示取不到有效值。 InstanceFamily String 机型所属机型族
注意：此字段可能返回 null，表示取不到有效值。 InstanceType String 实例机型名称
注意：此字段可能返回 null，表示取不到有效值。 PodLimits PodLimitsByType 机型可支持的最大VPC-CNI模式Pod数量信息
注意：此字段可能返回 null，表示取不到有效值。

Pod所在的节点信息

被如下接口引用：DescribePodsBySpec。

名称类型描述 ClusterId String 集群 ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：cls- NodeName String 节点名称
注意：此字段可能返回 null，表示取不到有效值。
示例值：eklet-subnet-0j105iya Zone String 可用区
注意：此字段可能返回 null，表示取不到有效值。
示例值：ap-guangzhou-2 Namespace String 命名空间
注意：此字段可能返回 null，表示取不到有效值。
示例值：test Name String Pod 名称
注意：此字段可能返回 null，表示取不到有效值。
示例值：test-0

健康检查探测参数

被如下接口引用：CreateEKSContainerInstances, UpdateEKSContainerInstance。

名称类型必选描述 InitialDelaySeconds Integer 否 Number of seconds after the container has started before liveness probes are initiated.
注意：此字段可能返回 null，表示取不到有效值。 TimeoutSeconds Integer 否 Number of seconds after which the probe times out.
Defaults to 1 second. Minimum value is 1.
注意：此字段可能返回 null，表示取不到有效值。 PeriodSeconds Integer 否 How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
注意：此字段可能返回 null，表示取不到有效值。 SuccessThreshold Integer 否 Minimum consecutive successes for the probe to be considered successful after having failed.Defaults to 1. Must be 1 for liveness. Minimum value is 1.
注意：此字段可能返回 null，表示取不到有效值。 FailureThreshold Integer 否 Minimum consecutive failures for the probe to be considered failed after having succeeded.Defaults to 3. Minimum value is 1.
注意：此字段可能返回 null，表示取不到有效值。

托管Prometheus agent信息

被如下接口引用：DeletePrometheusClusterAgent。

名称类型必选描述 ClusterType String 是集群类型 ClusterId String 是集群id Describe String 否备注 Region String 否集群所在地域

托管prometheus agent概览

被如下接口引用：DescribePrometheusAgents, DescribePrometheusClusterAgents。

名称类型描述 ClusterType String 集群类型
示例值：tke ClusterId String 集群id
示例值：cls-xxx Status String agent状态
normal = 正常
abnormal = 异常
示例值：normal ClusterName String 集群名称
示例值：tke集群 ExternalLabels Array of Label 额外labels
本集群的所有指标都会带上这几个label
注意：此字段可能返回 null，表示取不到有效值。
示例值：Name=cluster_name,Value=x Region String 集群所在地域
注意：此字段可能返回 null，表示取不到有效值。
示例值：ap-beijing VpcId String 集群所在VPC ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：xxx FailedReason String 记录关联等操作的失败信息
注意：此字段可能返回 null，表示取不到有效值。
示例值：xxx

prometheus告警历史

被如下接口引用：DescribePrometheusAlertHistory。

名称类型必选描述 RuleName String 是告警名称
示例值：alert StartTime String 是告警开始时间
示例值：s Content String 是告警内容
示例值：s State String 否告警状态
注意：此字段可能返回 null，表示取不到有效值。
示例值：firing RuleItem String 否触发的规则名称
注意：此字段可能返回 null，表示取不到有效值。
示例值：test TopicId String 否告警渠道的id
注意：此字段可能返回 null，表示取不到有效值。
示例值：topic-x TopicName String 否告警渠道的名称
注意：此字段可能返回 null，表示取不到有效值。
示例值：prom-xx-default-topic

告警渠道使用自建alertmanager的配置

被如下接口引用：CreatePrometheusAlertPolicy, CreatePrometheusGlobalNotification, DescribePrometheusAlertPolicy, DescribePrometheusGlobalNotification, ModifyPrometheusAlertPolicy, ModifyPrometheusGlobalNotification, ModifyPrometheusTemp。

名称类型必选描述 Url String 是 alertmanager url ClusterType String 否 alertmanager部署所在集群类型
注意：此字段可能返回 null，表示取不到有效值。 ClusterId String 否 alertmanager部署所在集群ID
注意：此字段可能返回 null，表示取不到有效值。

托管prometheus告警策略实例

被如下接口引用：CreatePrometheusAlertPolicy, CreatePrometheusTemp, DescribePrometheusAlertPolicy, DescribePrometheusTemp, ModifyPrometheusAlertPolicy, ModifyPrometheusTemp。

名称类型必选描述 Name String 是策略名称 Rules Array of PrometheusAlertRule 是规则列表 Id String 否告警策略 id
注意：此字段可能返回 null，表示取不到有效值。 TemplateId String 否如果该告警来自模板下发，则TemplateId为模板id
注意：此字段可能返回 null，表示取不到有效值。 Notification PrometheusNotificationItem 否告警渠道，模板中使用可能返回null
注意：此字段可能返回 null，表示取不到有效值。 UpdatedAt String 否最后修改时间
注意：此字段可能返回 null，表示取不到有效值。 ClusterId String 否如果告警策略来源于用户集群CRD资源定义，则ClusterId为所属集群ID
注意：此字段可能返回 null，表示取不到有效值。

Prometheus告警规则

被如下接口引用：CreatePrometheusAlertPolicy, CreatePrometheusAlertRule, CreatePrometheusTemplate, DescribePrometheusAlertPolicy, DescribePrometheusAlertRule, DescribePrometheusTemplates, ModifyPrometheusAlertPolicy, ModifyPrometheusAlertRule, ModifyPrometheusTemp, ModifyPrometheusTemplate。

名称类型必选描述 Name String 是规则名称
示例值：example Rule String 是 prometheus语句
示例值：example Labels Array of Label 是额外标签
示例值：Name=a,Value=b Template String 是告警发送模板
示例值：temp-xxx For String 是持续时间
示例值：1s Describe String 否该条规则的描述信息
注意：此字段可能返回 null，表示取不到有效值。
示例值：example-describe Annotations Array of Label 否参考prometheus rule中的annotations
注意：此字段可能返回 null，表示取不到有效值。
示例值：Name=a,Value=b RuleState Integer 否告警规则状态
注意：此字段可能返回 null，表示取不到有效值。

托管prometheus告警配置实例

被如下接口引用：CreatePrometheusAlertRule, CreatePrometheusTemplate, DescribePrometheusAlertRule, DescribePrometheusTemplates, ModifyPrometheusAlertRule, ModifyPrometheusTemplate。

名称类型必选描述 Name String 是规则名称
示例值：实例告警 Rules Array of PrometheusAlertRule 是规则列表 UpdatedAt String 否最后修改时间 Notification PrometheusNotification 否告警渠道 Id String 否告警 id
示例值：alert-xxx TemplateId String 否如果该告警来至模板下发，则TemplateId为模板id
注意：此字段可能返回 null，表示取不到有效值。
示例值：temp-xxx Interval String 否计算周期
注意：此字段可能返回 null，表示取不到有效值。
示例值：30s

与云监控融合托管prometheus实例，关联集群基础信息

被如下接口引用：CreatePrometheusClusterAgent。

名称类型必选描述 Region String 是集群ID
示例值：xx-xxx ClusterType String 是集群类型
示例值：tke ClusterId String 是集群ID
示例值：cls-xxx EnableExternal Boolean 是是否开启公网CLB
示例值：false InClusterPodConfig PrometheusClusterAgentPodConfig 否集群内部署组件的pod配置
示例值：pod配置 ExternalLabels Array of Label 否该集群采集的所有指标都会带上这些labels
示例值：额外的labels NotInstallBasicScrape Boolean 否是否安装默认采集配置 NotScrape Boolean 否是否采集指标，true代表drop所有指标，false代表采集默认指标

关联集群时在集群内部署组件的pod额外配置

被如下接口引用：CreatePrometheusClusterAgent。

名称类型必选描述 HostNet Boolean 否是否使用HostNetWork
示例值：true NodeSelector Array of Label 否指定pod运行节点 Tolerations Array of Toleration 否容忍污点

prometheus配置

被如下接口引用：CreatePrometheusConfig, CreatePrometheusTemp, CreatePrometheusTemplate, DescribePrometheusConfig, DescribePrometheusGlobalConfig, DescribePrometheusTemp, DescribePrometheusTemplates, ModifyPrometheusConfig, ModifyPrometheusTemp, ModifyPrometheusTemplate。

名称类型必选描述 Name String 是名称 Config String 是配置内容 TemplateId String 否用于出参，如果该配置来至模板，则为模板id
注意：此字段可能返回 null，表示取不到有效值。

托管prometheus中grafana的信息

被如下接口引用：DescribePrometheusInstance。

名称类型描述 Enabled Boolean 是否启用
示例值：true Domain String 域名，只有开启外网访问才有效果
示例值：http://grafana.com Address String 内网地址，或者外网地址
示例值：http://1.1.1.1 Internet String 是否开启了外网访问
close = 未开启外网访问
opening = 正在开启外网访问
open = 已开启外网访问
示例值：open AdminUser String grafana管理员用户名
示例值：admin

托管prometheus实例概览

被如下接口引用：DescribePrometheusOverviews。

名称类型描述 InstanceId String 实例id
示例值：prom-xxx Name String 实例名称
示例值：test VpcId String 实例vpcId
示例值：vpc-xxx SubnetId String 实例子网Id
示例值：subnet-xxx Status String 实例当前的状态
prepare_env = 初始化环境
install_suit = 安装组件
running = 运行中
示例值：running COSBucket String COS桶存储
示例值：prom-xxx-data-0 GrafanaURL String grafana默认地址，如果开启外网访问得为域名，否则为内网地址
注意：此字段可能返回 null，表示取不到有效值。
示例值：http://1.1.1.1 BoundTotal Integer 关联集群总数
注意：此字段可能返回 null，表示取不到有效值。
示例值：1 BoundNormal Integer 运行正常的集群数
注意：此字段可能返回 null，表示取不到有效值。
示例值：1

托管prometheusV2实例概览

被如下接口引用：DescribePrometheusInstancesOverview。

名称类型描述 InstanceId String 实例ID
示例值：prom-xxx InstanceName String 实例名
示例值：xxx VpcId String VPC ID
示例值：vpc-xxx SubnetId String 子网ID
示例值：subnet-xxx InstanceStatus Integer 运行状态（1:正在创建；2:运行中；3:异常；4:重启中；5:销毁中； 6:已停机； 7: 已删除）
示例值：2 ChargeStatus Integer 计费状态（1:正常；2:过期; 3:销毁; 4:分配中; 5:分配失败）
注意：此字段可能返回 null，表示取不到有效值。
示例值：1 EnableGrafana Integer 是否开启 Grafana（0:不开启，1:开启）
示例值：1 GrafanaURL String Grafana 面板 URL
注意：此字段可能返回 null，表示取不到有效值。
示例值：https://prom-xxx.grafana.xxx.prom.tencent-cloud.com InstanceChargeType Integer 实例付费类型（1:试用版；2:预付费）
示例值：2 SpecName String 规格名称
注意：此字段可能返回 null，表示取不到有效值。
示例值：基础1 DataRetentionTime Integer 存储周期
注意：此字段可能返回 null，表示取不到有效值。
示例值：15 ExpireTime String 购买的实例过期时间
注意：此字段可能返回 null，表示取不到有效值。
示例值：2021-12-14T17:16:12+08:00 AutoRenewFlag Integer 自动续费标记(0:不自动续费；1:开启自动续费；2:禁止自动续费；-1:无效)
注意：此字段可能返回 null，表示取不到有效值。
示例值：1 BoundTotal Integer 绑定集群总数
示例值：2 BoundNormal Integer 绑定集群正常状态总数
示例值：2

prometheus一个job的targets

被如下接口引用：DescribePrometheusTargets。

名称类型描述 Targets Array of PrometheusTarget 该Job的targets列表 JobName String job的名称 Total Integer targets总数 Up Integer 健康的target总数

amp告警渠道配置

被如下接口引用：CreatePrometheusAlertRule, DescribePrometheusAlertRule, ModifyPrometheusAlertRule, ModifyPrometheusTemplate。

名称类型必选描述 Enabled Boolean 是是否启用 RepeatInterval String 是收敛时间 TimeRangeStart String 是生效起始时间 TimeRangeEnd String 是生效结束时间 NotifyWay Array of String 否告警通知方式。目前有SMS、EMAIL、CALL、WECHAT方式。
分别代表：短信、邮件、电话、微信
注意：此字段可能返回 null，表示取不到有效值。 ReceiverGroups Array of Integer 否告警接收组（用户组）
注意：此字段可能返回 null，表示取不到有效值。 PhoneNotifyOrder Array of Integer 否电话告警顺序。
注：NotifyWay选择CALL，采用该参数。
注意：此字段可能返回 null，表示取不到有效值。 PhoneCircleTimes Integer 否电话告警次数。
注：NotifyWay选择CALL，采用该参数。
注意：此字段可能返回 null，表示取不到有效值。 PhoneInnerInterval Integer 否电话告警轮内间隔。单位：秒
注：NotifyWay选择CALL，采用该参数。
注意：此字段可能返回 null，表示取不到有效值。 PhoneCircleInterval Integer 否电话告警轮外间隔。单位：秒
注：NotifyWay选择CALL，采用该参数。
注意：此字段可能返回 null，表示取不到有效值。 PhoneArriveNotice Boolean 否电话告警触达通知
注：NotifyWay选择CALL，采用该参数。
注意：此字段可能返回 null，表示取不到有效值。 Type String 否通道类型，默认为amp，支持以下
amp
webhook
注意：此字段可能返回 null，表示取不到有效值。 WebHook String 否如果Type为webhook, 则该字段为必填项
注意：此字段可能返回 null，表示取不到有效值。

告警通知渠道配置

名称类型必选描述 Enabled Boolean 是是否启用 Type String 是通道类型，默认为amp，支持以下
amp
webhook
alertmanager WebHook String 否如果Type为webhook, 则该字段为必填项
注意：此字段可能返回 null，表示取不到有效值。 AlertManager PrometheusAlertManagerConfig 否如果Type为alertmanager, 则该字段为必填项
注意：此字段可能返回 null，表示取不到有效值。 RepeatInterval String 否收敛时间 TimeRangeStart String 否生效起始时间 TimeRangeEnd String 否生效结束时间 NotifyWay Array of String 否告警通知方式。目前有SMS、EMAIL、CALL、WECHAT方式。
注意：此字段可能返回 null，表示取不到有效值。 ReceiverGroups Array of String 否告警接收组（用户组）
注意：此字段可能返回 null，表示取不到有效值。 PhoneNotifyOrder Array of Integer 否电话告警顺序。
注：NotifyWay选择CALL，采用该参数。
注意：此字段可能返回 null，表示取不到有效值。 PhoneCircleTimes Integer 否电话告警次数。
注：NotifyWay选择CALL，采用该参数。
注意：此字段可能返回 null，表示取不到有效值。 PhoneInnerInterval Integer 否电话告警轮内间隔。单位：秒
注：NotifyWay选择CALL，采用该参数。
注意：此字段可能返回 null，表示取不到有效值。 PhoneCircleInterval Integer 否电话告警轮外间隔。单位：秒
注：NotifyWay选择CALL，采用该参数。
注意：此字段可能返回 null，表示取不到有效值。 PhoneArriveNotice Boolean 否电话告警触达通知
注：NotifyWay选择CALL，采用该参数。
注意：此字段可能返回 null，表示取不到有效值。

prometheus聚合规则实例详情，包含所属集群ID

被如下接口引用：DescribePrometheusRecordRules。

名称类型描述 Name String 实例名称 UpdateTime String 最近更新时间 TemplateId String Yaml内容 Content String 如果该聚合规则来至模板，则TemplateId为模板id
注意：此字段可能返回 null，表示取不到有效值。 ClusterId String 该聚合规则如果来源于用户集群crd资源定义，则ClusterId为所属集群ID
注意：此字段可能返回 null，表示取不到有效值。

prometheus一个抓取目标的信息

被如下接口引用：DescribePrometheusTargets。

名称类型描述 Url String 抓取目标的URL State String target当前状态,当前支持
up = 健康
down = 不健康
unknown = 未知 Labels Array of Label target的元label LastScrape String 上一次抓取的时间 ScrapeDuration Float 上一次抓取的耗时，单位是s Error String 上一次抓取如果错误，该字段存储错误信息

模板实例

被如下接口引用：CreatePrometheusTemp, DescribePrometheusTemp。

名称类型必选描述 Name String 是模板名称 Level String 是模板维度，支持以下类型
instance 实例级别
cluster 集群级别 Describe String 否模板描述
注意：此字段可能返回 null，表示取不到有效值。 RecordRules Array of PrometheusConfigItem 否当Level为instance时有效，
模板中的聚合规则列表
注意：此字段可能返回 null，表示取不到有效值。 ServiceMonitors Array of PrometheusConfigItem 否当Level为cluster时有效，
模板中的ServiceMonitor规则列表
注意：此字段可能返回 null，表示取不到有效值。 PodMonitors Array of PrometheusConfigItem 否当Level为cluster时有效，
模板中的PodMonitors规则列表
注意：此字段可能返回 null，表示取不到有效值。 RawJobs Array of PrometheusConfigItem 否当Level为cluster时有效，
模板中的RawJobs规则列表
注意：此字段可能返回 null，表示取不到有效值。 TemplateId String 否模板的ID, 用于出参
注意：此字段可能返回 null，表示取不到有效值。 UpdateTime String 否最近更新时间，用于出参
注意：此字段可能返回 null，表示取不到有效值。 Version String 否当前版本，用于出参
注意：此字段可能返回 null，表示取不到有效值。 IsDefault Boolean 否是否系统提供的默认模板，用于出参
注意：此字段可能返回 null，表示取不到有效值。 AlertDetailRules Array of PrometheusAlertPolicyItem 否当Level为instance时有效，
模板中的告警配置列表
注意：此字段可能返回 null，表示取不到有效值。 TargetsTotal Integer 否关联实例数目
注意：此字段可能返回 null，表示取不到有效值。

云原生Prometheus模板可修改项

被如下接口引用：ModifyPrometheusTemp。

名称类型必选描述 Name String 否修改名称 Describe String 否修改描述
注意：此字段可能返回 null，表示取不到有效值。 ServiceMonitors Array of PrometheusConfigItem 否当Level为cluster时有效，
模板中的ServiceMonitor规则列表
注意：此字段可能返回 null，表示取不到有效值。 PodMonitors Array of PrometheusConfigItem 否当Level为cluster时有效，
模板中的PodMonitors规则列表
注意：此字段可能返回 null，表示取不到有效值。 RawJobs Array of PrometheusConfigItem 否当Level为cluster时有效，
模板中的RawJobs规则列表
注意：此字段可能返回 null，表示取不到有效值。 RecordRules Array of PrometheusConfigItem 否当Level为instance时有效，
模板中的聚合规则列表
注意：此字段可能返回 null，表示取不到有效值。 AlertDetailRules Array of PrometheusAlertPolicyItem 否修改内容，只有当模板类型是Alert时生效
注意：此字段可能返回 null，表示取不到有效值。

模板实例

被如下接口引用：CreatePrometheusTemplate, DescribePrometheusTemplates。

名称类型必选描述 Name String 是模板名称 Level String 是模板维度，支持以下类型
instance 实例级别
cluster 集群级别 Describe String 否模板描述
注意：此字段可能返回 null，表示取不到有效值。 AlertRules Array of PrometheusAlertRule 否当Level为instance时有效，
模板中的告警配置列表
注意：此字段可能返回 null，表示取不到有效值。 RecordRules Array of PrometheusConfigItem 否当Level为instance时有效，
模板中的聚合规则列表
注意：此字段可能返回 null，表示取不到有效值。 ServiceMonitors Array of PrometheusConfigItem 否当Level为cluster时有效，
模板中的ServiceMonitor规则列表
注意：此字段可能返回 null，表示取不到有效值。 PodMonitors Array of PrometheusConfigItem 否当Level为cluster时有效，
模板中的PodMonitors规则列表
注意：此字段可能返回 null，表示取不到有效值。 RawJobs Array of PrometheusConfigItem 否当Level为cluster时有效，
模板中的RawJobs规则列表
注意：此字段可能返回 null，表示取不到有效值。 TemplateId String 否模板的ID, 用于出参
注意：此字段可能返回 null，表示取不到有效值。 UpdateTime String 否最近更新时间，用于出参
注意：此字段可能返回 null，表示取不到有效值。 Version String 否当前版本，用于出参
注意：此字段可能返回 null，表示取不到有效值。 IsDefault Boolean 否是否系统提供的默认模板，用于出参
注意：此字段可能返回 null，表示取不到有效值。 AlertDetailRules Array of PrometheusAlertRuleDetail 否当Level为instance时有效，
模板中的告警配置列表
注意：此字段可能返回 null，表示取不到有效值。

云原生Prometheus模板可修改项

被如下接口引用：ModifyPrometheusTemplate。

名称类型必选描述 Name String 否修改名称 Describe String 否修改描述
注意：此字段可能返回 null，表示取不到有效值。 AlertRules Array of PrometheusAlertRule 否修改内容，只有当模板类型是Alert时生效
注意：此字段可能返回 null，表示取不到有效值。 RecordRules Array of PrometheusConfigItem 否当Level为instance时有效，
模板中的聚合规则列表
注意：此字段可能返回 null，表示取不到有效值。 ServiceMonitors Array of PrometheusConfigItem 否当Level为cluster时有效，
模板中的ServiceMonitor规则列表
注意：此字段可能返回 null，表示取不到有效值。 PodMonitors Array of PrometheusConfigItem 否当Level为cluster时有效，
模板中的PodMonitors规则列表
注意：此字段可能返回 null，表示取不到有效值。 RawJobs Array of PrometheusConfigItem 否当Level为cluster时有效，
模板中的RawJobs规则列表
注意：此字段可能返回 null，表示取不到有效值。 AlertDetailRules Array of PrometheusAlertRuleDetail 否修改内容，只有当模板类型是Alert时生效
注意：此字段可能返回 null，表示取不到有效值。

云原生Prometheus模板同步目标

被如下接口引用：DeletePrometheusTempSync, DeletePrometheusTemplateSync, DescribePrometheusTempSync, DescribePrometheusTemplateSync, SyncPrometheusTemp, SyncPrometheusTemplate。

名称类型必选描述 Region String 是目标所在地域 InstanceId String 是目标实例 ClusterId String 否集群id，只有当采集模板的Level为cluster的时候需要
注意：此字段可能返回 null，表示取不到有效值。 SyncTime String 否最后一次同步时间，用于出参
注意：此字段可能返回 null，表示取不到有效值。 Version String 否当前使用的模板版本，用于出参
注意：此字段可能返回 null，表示取不到有效值。 ClusterType String 否集群类型，只有当采集模板的Level为cluster的时候需要
注意：此字段可能返回 null，表示取不到有效值。 InstanceName String 否用于出参，实例名称
注意：此字段可能返回 null，表示取不到有效值。 ClusterName String 否用于出参，集群名称
注意：此字段可能返回 null，表示取不到有效值。

预留券抵扣详情

被如下接口引用：DescribeRIUtilizationDetail。

名称类型描述 ReservedInstanceId String 预留券ID
示例值：eksri-xxxxxxxx EksId String Pod唯一ID
示例值：eks-xxxxxxxx ClusterId String 集群ID
示例值：cls-xxxxxxxx Name String Pod的名称
示例值：test Namespace String Pod的命名空间
示例值：default Kind String 工作负载类型
示例值：pod KindName String 工作负载名称
示例值：test Uid String Pod的uid
示例值：4c243e72-1322-409d-a352-5c2e3495cd40 StartTime String 用量开始时间
示例值：2006-01-02 15:04:05 EndTime String 用量结束时间
示例值：2006-01-02 15:04:05 Product String 抵扣资源所属产品
示例值：eks

地域属性信息

被如下接口引用：DescribeRegions。

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

应用市场部署的应用结构

被如下接口引用：DescribeClusterReleases。

名称类型描述 Name String 应用名称 Namespace String 应用命名空间 Revision String 应用当前版本
注意：此字段可能返回 null，表示取不到有效值。 Status String 应用状态
注意：此字段可能返回 null，表示取不到有效值。 ChartName String 制品名称
注意：此字段可能返回 null，表示取不到有效值。 ChartVersion String 制品版本
注意：此字段可能返回 null，表示取不到有效值。 AppVersion String 制品应用版本
注意：此字段可能返回 null，表示取不到有效值。 UpdatedTime String 更新时间
注意：此字段可能返回 null，表示取不到有效值。 Description String 应用描述
注意：此字段可能返回 null，表示取不到有效值。

应用市场的安装应用详情

被如下接口引用：DescribeClusterReleaseDetails。

名称类型描述 Name String 应用名称
示例值：test Namespace String 应用所在命名空间
示例值：default Version Integer 应用当前版本
注意：此字段可能返回 null，表示取不到有效值。
示例值：2 Status String 应用状态
注意：此字段可能返回 null，表示取不到有效值。
示例值：deployed Description String 应用描述
注意：此字段可能返回 null，表示取不到有效值。
示例值：xxx Notes String 应用提示
注意：此字段可能返回 null，表示取不到有效值。
示例值：xxx Config String 用户自定义参数
注意：此字段可能返回 null，表示取不到有效值。
示例值：xxx Manifest String 应用资源详情
注意：此字段可能返回 null，表示取不到有效值。
示例值：xxx ChartVersion String 应用制品版本
注意：此字段可能返回 null，表示取不到有效值。
示例值：1.0.0 ChartName String 应用制品名称
注意：此字段可能返回 null，表示取不到有效值。
示例值：test ChartDescription String 应用制品描述
注意：此字段可能返回 null，表示取不到有效值。
示例值：xxx AppVersion String 应用制品app版本
注意：此字段可能返回 null，表示取不到有效值。
示例值：v1.0.0 FirstDeployedTime String 应用首次部署时间
注意：此字段可能返回 null，表示取不到有效值。
示例值：xxx LastDeployedTime String 应用最近部署时间
注意：此字段可能返回 null，表示取不到有效值。
示例值：xxx ComputedValues String 应用参数
注意：此字段可能返回 null，表示取不到有效值。
示例值：xxx

应用市场中部署的应用版本历史

被如下接口引用：DescribeClusterReleaseHistory。

名称类型描述 Name String 应用名称 Namespace String 应用命名空间 Revision Integer 应用版本
注意：此字段可能返回 null，表示取不到有效值。 Status String 应用状态
注意：此字段可能返回 null，表示取不到有效值。 Chart String 应用制品名称
注意：此字段可能返回 null，表示取不到有效值。 AppVersion String 应用制品版本
注意：此字段可能返回 null，表示取不到有效值。 UpdatedTime String 应用更新时间
注意：此字段可能返回 null，表示取不到有效值。 Description String 应用描述
注意：此字段可能返回 null，表示取不到有效值。

应用市场自定义参数

被如下接口引用：CreateClusterRelease, UpgradeClusterRelease。

名称类型必选描述 RawOriginal String 是自定义参数原始值 ValuesType String 是自定义参数值类型

预留实例

被如下接口引用：DescribeReservedInstances。

名称类型描述 ReservedInstanceId String 预留实例ID
示例值：eksri-xxxxxxxx ReservedInstanceName String 预留实例名称
示例值：test Status String 预留券状态
示例值：Active TimeSpan Integer 有效期，单位：月
示例值：1 ResourceType String 抵扣资源类型
示例值：amd Cpu Float 资源核数
示例值：1 Memory Float 资源内存，单位：Gi
示例值：2 Scope String 预留券的范围，默认值region。
示例值：ap-guangzhou-6 CreatedAt String 创建时间
示例值：2021-03-22 19:41:53 ActiveAt String 生效时间
示例值：2021-03-22 19:00:00 ExpireAt String 过期时间
示例值：2021-04-22 23:59:59 GpuCount String GPU卡数
示例值："0.5" AutoRenewFlag Integer 自动续费标记
示例值：0 ClusterId String 集群 ID
示例值：cls- NodeName String 节点名称
示例值：eklet-subnet- DeductStatus String 上个周期预留券的抵扣状态，Deduct、NotDeduct
示例值：Deduct

预留券抵扣范围的描述信息，当抵扣范围为 Region 时，表示地域抵扣，其他参数不需要传；当抵扣范围为 Zone 时，表示可用区抵扣，Zone 参数必传；当抵扣范围为 Node 时，表示节点抵扣，参数 Zone、ClusterId和NodeName均必传。

被如下接口引用：ModifyReservedInstanceScope。

名称类型必选描述 Scope String 是抵扣范围，取值：Region、Zone 和 Node
示例值：Region Zone String 否可用区
示例值：ap-guangzhou-2 ClusterId String 否集群 ID NodeName String 否节点名称

预留券规格

被如下接口引用：CreateReservedInstances。

名称类型必选描述 Type String 是资源类型：common、amd、v100、t4、a10*gnv4、a10*gnv4v、a10*pnv4、windows-common、windows-amd，common表示通用类型。
示例值：amd Cpu Float 是核数
示例值：1 Memory Float 是内存
示例值：2 Gpu Float 否 GPU卡数，当Type为GPU类型时设置。
示例值：0.5

预留券的使用率信息

被如下接口引用：DescribeReservedInstanceUtilizationRate。

名称类型描述 Rate Float 使用率
注意：此字段可能返回 null，表示取不到有效值。
示例值：1.0 Num Integer 预留券数量
注意：此字段可能返回 null，表示取不到有效值。
示例值：1 CPU Float 核数
注意：此字段可能返回 null，表示取不到有效值。
示例值：0.5 Memory Float 内存
注意：此字段可能返回 null，表示取不到有效值。
示例值：1.0 Type String 预留券类型
注意：此字段可能返回 null，表示取不到有效值。
示例值：common GpuNum String GPU 卡数
注意：此字段可能返回 null，表示取不到有效值。
示例值：0.5 Zone String 可用区
注意：此字段可能返回 null，表示取不到有效值。
示例值：ap-guangzhou-2 ClusterId String 集群 ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：cls- NodeName String 节点名称
注意：此字段可能返回 null，表示取不到有效值。
示例值：eklet-subnet- PodNum Integer Pod 数量
注意：此字段可能返回 null，表示取不到有效值。
示例值：1

资源删除选项

被如下接口引用：DeleteCluster。

名称类型必选描述 ResourceType String 是资源类型，例如CBS、CLB、CVM DeleteMode String 是集群删除时CBS资源的删除模式：terminate（销毁），retain （保留）。其他资源默认为销毁。 SkipDeletionProtection Boolean 否是否跳过开启删除保护的资源，默认false，设置为true时不清理开启了删除保护的资源，clb有终端节点的情况也属于开了删除保护。

集群资源使用量

被如下接口引用：DescribeResourceUsage。

名称类型描述 Name String 资源类型
示例值：Pod Usage Integer 资源使用量
示例值：100 Details Array of ResourceUsageDetail 资源使用详情

资源使用明细

被如下接口引用：DescribeResourceUsage。

名称类型描述 Name String 资源名称
示例值：clusterrolebindings Usage Integer 资源使用量
示例值：100

集群路由对象

被如下接口引用：DescribeClusterRoutes。

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

路由表冲突对象

被如下接口引用：DescribeRouteTableConflicts。

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

集群路由表对象

被如下接口引用：DescribeClusterRouteTables。

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

描述了 “云自动化助手” 服务相关的信息

被如下接口引用：AddExistedInstances, UpgradeClusterInstances。

名称类型必选描述 Enabled Boolean 否是否开启云自动化助手。取值范围：

true：表示开启云自动化助手服务

false：表示不开启云自动化助手服务

默认取值：false。
示例值：true

不同角色的节点配置参数

被如下接口引用：CreateCluster, ScaleOutClusterMaster。

名称类型必选描述 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生效）。

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

被如下接口引用：AddExistedInstances, UpgradeClusterInstances。

名称类型必选描述 Enabled Boolean 否是否开启云监控服务。取值范围：

true：表示开启云监控服务

false：表示不开启云监控服务

默认取值：true。
注意：此字段可能返回 null，表示取不到有效值。
示例值：true

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

被如下接口引用：AddExistedInstances, UpgradeClusterInstances。

名称类型必选描述 Enabled Boolean 否是否开启云安全服务。取值范围：

true：表示开启云安全服务

false：表示不开启云安全服务

默认取值：true。
示例值：false

运行时配置

被如下接口引用：DescribeClusterNodePoolDetail, DescribeClusterNodePools, ModifyClusterRuntimeConfig。

名称类型必选描述 RuntimeType String 否运行时类型
注意：此字段可能返回 null，表示取不到有效值。 RuntimeVersion String 否运行时版本
注意：此字段可能返回 null，表示取不到有效值。

master节点缩容参数

被如下接口引用：ScaleInClusterMaster。

名称类型必选描述 InstanceId String 是实例ID
示例值：ins-0xab1234 NodeRole String 是缩容的实例角色：MASTER,ETCD,MASTER_ETCD
示例值：MASTER_ETCD InstanceDeleteMode String 是实例删除时的策略：terminate（销毁实例，仅支持按量计费云主机实例） retain （仅移除，保留实例）
示例值：retain

cloudrun安全特性

被如下接口引用：CreateEKSContainerInstances, DescribeEKSContainerInstances, UpdateEKSContainerInstance。

名称类型必选描述 Capabilities Capabilities 否安全能力清单
注意：此字段可能返回 null，表示取不到有效值。
示例值：["NET_ADMIN", "SYS_TIME"]

ServiceAccount认证相关配置

被如下接口引用：DescribeClusterAuthenticationOptions, ModifyClusterAuthenticationOptions。

名称类型必选描述 UseTKEDefault Boolean 否使用TKE默认issuer和jwksuri
注意：此字段可能返回 null，表示取不到有效值。
示例值：false Issuer String 否 service-account-issuer
注意：此字段可能返回 null，表示取不到有效值。
示例值：https://cls-xxxxxxxx.ccs.tencent-cloud.com JWKSURI String 否 service-account-jwks-uri
注意：此字段可能返回 null，表示取不到有效值。
示例值：https://cls-xxxxxxxx.ccs.tencent-cloud.com:60002/openid/v1/jwks AutoCreateDiscoveryAnonymousAuth Boolean 否如果为true，则会自动创建允许匿名用户访问‘/.well-known/openid-configuration’和/openid/v1/jwks的rbac规则
注意：此字段可能返回 null，表示取不到有效值。
示例值：true

执行步骤信息

被如下接口引用：DescribeExternalNodeSupportConfig。

名称类型描述 Name String 名称
示例值："ensureNodeMasterCommunication" StartAt String 开始时间
注意：此字段可能返回 null，表示取不到有效值。
示例值："2022-07-12-14-23-04" EndAt String 结束时间
注意：此字段可能返回 null，表示取不到有效值。
示例值："2022-07-12-14-24-04" Status String 当前状态
注意：此字段可能返回 null，表示取不到有效值。
示例值："Success" Message String 执行信息
注意：此字段可能返回 null，表示取不到有效值。
示例值："null"

子网信息

被如下接口引用：CreateEKSCluster。

名称类型必选描述 SubnetId String 是子网id
示例值：subnet-xxx Name String 是子网节点名称
示例值：access-server SecurityGroups Array of String 否安全组id
示例值：sg-xxxxx,sg-xxxx Os String 否系统，默认linux
示例值：linux Arch String 否硬件架构，默认amd64
示例值：amd64

超级节点上的资源统计

被如下接口引用：DescribePostNodeResources。

名称类型描述 NodeName String 节点名称
注意：此字段可能返回 null，表示取不到有效值。
示例值：eklet-subnet- Num Integer 节点上的资源总数
注意：此字段可能返回 null，表示取不到有效值。
示例值：1 Cpu Float 节点上的总核数
注意：此字段可能返回 null，表示取不到有效值。
示例值：1 Memory Float 节点上的总内存数
注意：此字段可能返回 null，表示取不到有效值。
示例值：1 Gpu Float 节点上的总 GPU 卡数
注意：此字段可能返回 null，表示取不到有效值。
示例值：0

集群日志开关集合

被如下接口引用：DescribeLogSwitches。

名称类型描述 ClusterId String 集群ID Audit SwitchInfo 审计开关的详细信息
注意：此字段可能返回 null，表示取不到有效值。 Event SwitchInfo 事件开关的详细信息
注意：此字段可能返回 null，表示取不到有效值。 Log SwitchInfo 普通日志的详细信息
注意：此字段可能返回 null，表示取不到有效值。 MasterLog SwitchInfo master 日志详细信息
注意：此字段可能返回 null，表示取不到有效值。

日志开关详细信息

被如下接口引用：DescribeLogSwitches。

名称类型描述 Enable Boolean 开启标识符 true代表开启
注意：此字段可能返回 null，表示取不到有效值。
示例值：true LogsetId String CLS日志集ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：d12706e7-ae3b-42cf-9dab-d41e71489j4d TopicId String CLS日志主题ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：77b6130b-81cf-46dc-9faf-8d4b5afc1rt3s Version String 当前log-agent版本
注意：此字段可能返回 null，表示取不到有效值。
示例值：1.1.10 UpgradeAble Boolean 是否可升级
注意：此字段可能返回 null，表示取不到有效值。
示例值：true TopicRegion String CLS日志主题所属region
注意：此字段可能返回 null，表示取不到有效值。
示例值：ap-guangzhou

标签绑定的资源类型，当前支持类型："cluster"

被如下接口引用：CreateCluster, CreateClusterNodePool, CreateClusterVirtualNode, CreateClusterVirtualNodePool, CreateEKSCluster, CreateTKEEdgeCluster, DescribeBatchModifyTagsStatus, DescribeClusterNodePoolDetail, DescribeClusterNodePools, DescribeClusters, DescribeEKSClusters, DescribeTKEEdgeClusters, ModifyClusterNodePool, ModifyClusterTags。

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

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

被如下接口引用：CreateCluster, CreateEKSCluster, CreateTKEEdgeCluster, DescribeClusters, DescribeEKSClusters, DescribeTKEEdgeClusters。

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

kubernetes Taint

被如下接口引用：AddExistedInstances, CreateCluster, CreateClusterInstances, CreateClusterNodePool, CreateClusterVirtualNodePool, DescribeClusterNodePoolDetail, DescribeClusterNodePools, DescribeClusterVirtualNodePools, ModifyClusterNodePool, ModifyClusterVirtualNodePool, ScaleOutClusterMaster。

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

任务步骤信息

被如下接口引用：DescribePrometheusInstanceInitStatus, GetUpgradeInstanceProgress。

名称类型描述 Step String 步骤名称
示例值：preCheck LifeState String 生命周期
pending : 步骤未开始
running: 步骤执行中
success: 步骤成功完成
failed: 步骤失败
示例值：success StartAt String 步骤开始时间
注意：此字段可能返回 null，表示取不到有效值。
示例值：2022-04-19T07:29:46Z EndAt String 步骤结束时间
注意：此字段可能返回 null，表示取不到有效值。
示例值：2022-04-19T07:29:46Z FailedMsg String 若步骤生命周期为failed,则此字段显示错误信息
注意：此字段可能返回 null，表示取不到有效值。
示例值：显示错误信息

探针使用TcpSocket检测容器

被如下接口引用：CreateEKSContainerInstances, UpdateEKSContainerInstance。

名称类型必选描述 Port Integer 否 TcpSocket检测的端口
注意：此字段可能返回 null，表示取不到有效值。
示例值：80

kubernetes Taint

被如下接口引用：CreatePrometheusClusterAgent。

名称类型必选描述 Key String 否容忍应用到的 taint key Operator String 否键与值的关系 Effect String 否要匹配的污点效果

不可用原因

被如下接口引用：CheckInstancesUpgradeAble。

名称类型描述 InstanceId String 实例ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：ins-q40fqbso Reason String 原因
注意：此字段可能返回 null，表示取不到有效值。
示例值：instance already the master latest version

可升级节点信息

被如下接口引用：CheckInstancesUpgradeAble。

名称类型描述 InstanceId String 节点Id Version String 节点的当前版本 LatestVersion String 当前版本的最新小版本
注意：此字段可能返回 null，表示取不到有效值。 RuntimeVersion String RuntimeVersion RuntimeLatestVersion String RuntimeLatestVersion

节点升级重装参数

被如下接口引用：UpgradeClusterInstances。

名称类型必选描述 InstanceAdvancedSettings InstanceAdvancedSettings 否实例额外需要设置参数信息 EnhancedService EnhancedService 否增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数，则默认开启云监控、云安全服务。 LoginSettings LoginSettings 否节点登录信息（目前仅支持使用Password或者单个KeyIds） SecurityGroupIds Array of String 否实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。若不指定该参数，则绑定默认安全组。（目前仅支持设置单个sgId）

版本信息

被如下接口引用：DescribeVersions。

名称类型描述 Name String 版本名称
注意：此字段可能返回 null，表示取不到有效值。 Version String 版本信息
注意：此字段可能返回 null，表示取不到有效值。 Remark String Remark
注意：此字段可能返回 null，表示取不到有效值。

虚拟节点

被如下接口引用：DescribeClusterVirtualNode。

名称类型描述 Name String 虚拟节点名称 SubnetId String 虚拟节点所属子网 Phase String 虚拟节点状态 CreatedTime String 创建时间
注意：此字段可能返回 null，表示取不到有效值。

虚拟节点池

被如下接口引用：DescribeClusterVirtualNodePools。

名称类型描述 NodePoolId String 节点池ID SubnetIds Array of String 子网列表
注意：此字段可能返回 null，表示取不到有效值。 Name String 节点池名称 LifeState String 节点池生命周期 Labels Array of Label 虚拟节点label
注意：此字段可能返回 null，表示取不到有效值。 Taints Array of Taint 虚拟节点taint
注意：此字段可能返回 null，表示取不到有效值。

超级节点

被如下接口引用：CreateClusterVirtualNode, CreateClusterVirtualNodePool。

名称类型必选描述 DisplayName String 是节点展示名称
示例值：测试节点 SubnetId String 是子网ID
示例值：subnet-xxxxxx Tags Array of Tag 否腾讯云标签
示例值：[]

数据卷挂载路径信息

被如下接口引用：CreateEKSContainerInstances, UpdateEKSContainerInstance。

名称类型必选描述 Name String 是 volume名称
注意：此字段可能返回 null，表示取不到有效值。
示例值："" MountPath String 是挂载路径
注意：此字段可能返回 null，表示取不到有效值。
示例值："" ReadOnly Boolean 否是否只读
注意：此字段可能返回 null，表示取不到有效值。
示例值："" SubPath String 否子路径
注意：此字段可能返回 null，表示取不到有效值。
示例值："" MountPropagation String 否传播挂载方式
注意：此字段可能返回 null，表示取不到有效值。
示例值："" SubPathExpr String 否子路径表达式
注意：此字段可能返回 null，表示取不到有效值。
示例值：""

kubelet 参数（kubelet config）

相关推荐