数据结构

Addon

addon的具体描述

被如下接口引用：DescribeAddon。

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

AnnotationValue

注释

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

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

AppChart

app所支持的chart

被如下接口引用：GetTkeAppChartList。

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

AutoScalingGroupRange

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

被如下接口引用：ModifyClusterAsGroupAttribute。

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

AutoUpgradeClusterLevel

自动变配集群等级

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

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

AutoscalingAdded

自动扩缩容的节点

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

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

BackupStorageLocation

仓储仓库信息

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

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

Capabilities

cloudrun安全特性能力

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

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

CbsVolume

EKS Instnace CBS volume

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

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

Cluster

集群信息结构体

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

ClusterAdvancedSettings

集群高级配置

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

ClusterAsGroup

集群关联的伸缩组信息

被如下接口引用：DescribeClusterAsGroups。

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

ClusterAsGroupAttribute

集群伸缩组属性

被如下接口引用：ModifyClusterAsGroupAttribute。

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

ClusterAsGroupOption

集群弹性伸缩配置

被如下接口引用：DescribeClusterAsGroupOption, 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，表示取不到有效值。

ClusterBasicSettings

描述集群的基本配置信息

被如下接口引用：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	否	自动变配集群等级，针对托管集群生效

ClusterCIDRSettings

集群容器网络相关参数

被如下接口引用：CreateCluster。

名称	类型	必选	描述
ClusterCIDR	String	否	用于分配集群容器和服务 IP 的 CIDR，不得与 VPC CIDR 冲突，也不得与同 VPC 内其他集群 CIDR 冲突。且网段范围必须在内网网段内，例如:10.1.0.0/14, 192.168.0.1/18,172.16.0.0/16。 示例值：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.1/18,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,15768000) 示例值：120
IgnoreServiceCIDRConflict	Boolean	否	是否忽略 ServiceCIDR 冲突错误, 仅在 VPC-CNI 模式生效，默认不忽略 示例值：false

ClusterCondition

集群创建过程

被如下接口引用：DescribeTKEEdgeClusterStatus。

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

ClusterCredential

接入k8s 的认证信息

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

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

ClusterExtraArgs

集群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"]

ClusterInternalLB

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

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

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

ClusterLevelAttribute

托管集群等级属性

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

ClusterLevelChangeRecord

集群等级变配记录

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

ClusterNetworkSettings

集群网络相关的参数

被如下接口引用：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"

ClusterProperty

集群属性

被如下接口引用：ModifyClusterAttribute。

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

ClusterPublicLB

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

被如下接口引用：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，表示取不到有效值。 示例值：""

ClusterStatus

集群状态信息

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

ClusterVersion

集群版本信息

被如下接口引用：DescribeAvailableClusterVersion。

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

CommonName

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

被如下接口引用：DescribeClusterCommonNames。

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

Container

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，表示取不到有效值。 示例值：""

ContainerState

容器状态

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

ControllerStatus

集群中控制器的状态描述

被如下接口引用：DescribeClusterControllers。

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

CustomDriver

自定义驱动信息

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

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

DNSConfig

自定义DNS配置

被如下接口引用：CreateEKSContainerInstances。

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

DNSConfigOption

DNS配置选项

被如下接口引用：CreateEKSContainerInstances。

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

DataDisk

描述了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

DnsServerConf

Eks 自定义域名服务器 配置

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

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

DriverVersion

GPU驱动和CUDA的版本信息

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

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

ECMEnhancedService

ECM增强服务

被如下接口引用：CreateECMInstances。

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

ECMRunMonitorServiceEnabled

ECM云监控服务

被如下接口引用：CreateECMInstances。

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

ECMRunSecurityServiceEnabled

ECM云镜服务

被如下接口引用：CreateECMInstances。

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

ECMZoneInstanceCountISP

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

被如下接口引用：CreateECMInstances。

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

EdgeArgsFlag

边缘容器参数描述

被如下接口引用：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，表示取不到有效值。

EdgeAvailableExtraArgs

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

被如下接口引用：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，表示取不到有效值。

EdgeCluster

边缘计算集群信息

被如下接口引用：DescribeTKEEdgeClusters。

名称	类型	必选	描述
ClusterId	String	是	集群Id 示例值：cls-xxxxxxxx
ClusterName	String	是	集群名称 示例值：test
VpcId	String	是	Vpc Id 示例值：vpc-xxxxxxxx
PodCIDR	String	是	集群pod cidr 示例值：10.0.0.1/16
ServiceCIDR	String	是	集群 service cidr 示例值：10.1.1.1/16
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，表示取不到有效值。

EdgeClusterAdvancedSettings

边缘容器集群高级配置

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

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

EdgeClusterExtraArgs

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

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

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

EdgeClusterInternalLB

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

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

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

EdgeClusterPublicLB

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

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

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

EipAttribute

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

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

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

EksCi

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，表示取不到有效值。 示例值：""

EksCiRegionInfo

EksCi地域信息

被如下接口引用：DescribeEKSContainerInstanceRegions。

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

EksCiVolume

EKS Instance Volume, 可选包括CbsVolume和NfsVolume

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

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

EksCluster

弹性集群信息

被如下接口引用：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，表示取不到有效值。 示例值：{}

EnhancedService

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

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

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

EnvironmentVariable

EnvironmentVariable

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

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

Event

服务事件

被如下接口引用：DescribeEKSContainerInstanceEvent。

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

Exec

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

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

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

ExistedInstance

已经存在的实例信息

被如下接口引用：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，表示取不到有效值。

ExistedInstancesForNode

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

被如下接口引用：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]

ExistedInstancesPara

已存在实例的重装参数

被如下接口引用：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一致)

ExtensionAddon

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

被如下接口引用：CreateCluster。

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

FailedResource

修改标签失败的资源

被如下接口引用：DescribeBatchModifyTagsStatus。

名称	类型	描述
Resource	String	资源六段式 注意：此字段可能返回 null，表示取不到有效值。 示例值：qcs::tke:${region}:uin/${uin}:cluster/${ClusterId}
Error	String	执行失败的原因 注意：此字段可能返回 null，表示取不到有效值。

Filter

过滤器

被如下接口引用：CheckInstancesUpgradeAble, DescribeClusterInstances, DescribeClusterNodePools, DescribeClusterRoutes, DescribeClusters, DescribeECMInstances, DescribeEKSClusters, DescribeEKSContainerInstances, DescribeEdgeCVMInstances, DescribeEdgeClusterInstances, DescribeExistedInstances, DescribeImageCaches, DescribePodsBySpec, DescribePrometheusAlertPolicy, DescribePrometheusAlertRule, DescribePrometheusInstancesOverview, DescribePrometheusOverviews, DescribePrometheusRecordRules, DescribePrometheusTargets, DescribePrometheusTemp, DescribePrometheusTemplates, DescribeRIUtilizationDetail, DescribeReservedInstances, DescribeTKEEdgeClusters。

名称	类型	必选	描述
Name	String	是	属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。
Values	Array of String	是	属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。

GPUArgs

GPU相关的参数，包括驱动版本，CUDA版本，cuDNN版本以及是否开启MIG

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

名称	类型	必选	描述
MIGEnable	Boolean	否	是否启用MIG特性 注意：此字段可能返回 null，表示取不到有效值。 示例值：false
Driver	DriverVersion	否	GPU驱动版本信息
CUDA	DriverVersion	否	CUDA版本信息 注意：此字段可能返回 null，表示取不到有效值。
CUDNN	CUDNN	否	cuDNN版本信息 注意：此字段可能返回 null，表示取不到有效值。
CustomDriver	CustomDriver	否	自定义GPU驱动信息 注意：此字段可能返回 null，表示取不到有效值。

HttpGet

Probe中的HttpGet

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

名称	类型	必选	描述
Path	String	是	HttpGet检测的路径 注意：此字段可能返回 null，表示取不到有效值。 示例值：/
Port	Integer	是	HttpGet检测的端口号 注意：此字段可能返回 null，表示取不到有效值。 示例值：80
Scheme	String	是	HTTP or HTTPS 注意：此字段可能返回 null，表示取不到有效值。 示例值：HTTP

IPAddress

IP 地址

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

名称	类型	必选	描述
Type	String	是	Ip 地址的类型。可为 advertise, public 等
Ip	String	是	Ip 地址
Port	Integer	是	网络端口

ImageCache

镜像缓存的信息

被如下接口引用：DescribeImageCaches, GetMostSuitableImageCache。

名称	类型	描述
ImageCacheId	String	镜像缓存Id 示例值：""
ImageCacheName	String	镜像缓存名称 示例值：""
ImageCacheSize	Integer	镜像缓存大小。单位：GiB 示例值：""
Images	Array of String	镜像缓存包含的镜像列表 示例值：""
CreationTime	String	创建时间 示例值：""
ExpireDateTime	String	到期时间 示例值：""
Events	Array of ImageCacheEvent	镜像缓存事件信息 示例值：""
LastMatchedTime	String	最新一次匹配到镜像缓存的时间 示例值：""
SnapshotId	String	镜像缓存对应的快照Id 示例值：""
Status	String	镜像缓存状态，可能取值： Pending：创建中 Ready：创建完成 Failed：创建失败 Updating：更新中 UpdateFailed：更新失败 只有状态为Ready时，才能正常使用镜像缓存 示例值：""

ImageCacheEvent

镜像缓存的事件

被如下接口引用：DescribeImageCaches, GetMostSuitableImageCache。

名称	类型	描述
ImageCacheId	String	镜像缓存Id 示例值：""
Type	String	事件类型, Normal或者Warning 示例值：""
Reason	String	事件原因简述 示例值：""
Message	String	事件原因详述 示例值：""
FirstTimestamp	String	事件第一次出现时间 示例值：""
LastTimestamp	String	事件最后一次出现时间 示例值：""

ImageInstance

镜像信息

被如下接口引用：DescribeImages。

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

ImageRegistryCredential

从镜像仓库拉取镜像的凭据

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

名称	类型	必选	描述
Server	String	否	镜像仓库地址 示例值：""
Username	String	否	用户名 示例值：""
Password	String	否	密码 示例值：""
Name	String	否	ImageRegistryCredential的名字 示例值：""

Instance

集群的实例信息

被如下接口引用：DescribeClusterInstances。

名称	类型	描述
InstanceId	String	实例ID 示例值：ins-xxxxxx
InstanceRole	String	节点角色, MASTER, WORKER, ETCD, MASTER_ETCD,ALL, 默认为WORKER 示例值：WORKER
FailedReason	String	实例异常(或者处于初始化中)的原因 示例值：=Ready:True
InstanceState	String	实例的状态（running 运行中，initializing 初始化中，failed 异常） 示例值：running
DrainStatus	String	实例是否封锁状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：drained
InstanceAdvancedSettings	InstanceAdvancedSettings	节点配置 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"MountTarget":"","DataDiskPartition":null,"DockerGraphPath":"",
CreatedTime	String	添加时间 示例值：2021-02-22T07:14:11Z
LanIP	String	节点内网IP 注意：此字段可能返回 null，表示取不到有效值。 示例值：null
NodePoolId	String	资源池ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：np-xxxxxxxx
AutoscalingGroupId	String	自动伸缩组ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：asg-xxxxxxxx

InstanceAdvancedSettings

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

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

名称	类型	必选	描述
DesiredPodNumber	Integer	是	该节点属于podCIDR大小自定义模式时，可指定节点上运行的pod数量上限 注意：此字段可能返回 null，表示取不到有效值。 示例值：16
GPUArgs	GPUArgs	是	GPU驱动相关参数,相关的GPU参数获取:https://cloud.tencent.com/document/api/213/15715 注意：此字段可能返回 null，表示取不到有效值。
PreStartUserScript	String	是	base64 编码的用户脚本，在初始化节点之前执行，目前只对添加已有节点生效 注意：此字段可能返回 null，表示取不到有效值。 示例值：#!/bin/sh echo "hello world"
Taints	Array of Taint	是	节点污点 注意：此字段可能返回 null，表示取不到有效值。
MountTarget	String	否	数据盘挂载点, 默认不挂载数据盘. 已格式化的 ext3，ext4，xfs 文件系统的数据盘将直接挂载，其他文件系统或未格式化的数据盘将自动格式化为ext4 (tlinux系统格式化成xfs)并挂载，请注意备份数据! 无数据盘或有多块数据盘的云主机此设置不生效。 注意，注意，多盘场景请使用下方的DataDisks数据结构，设置对应的云盘类型、云盘大小、挂载路径、是否格式化等信息。 注意：此字段可能返回 null，表示取不到有效值。 示例值：/tmp
DockerGraphPath	String	否	dockerd --graph 指定值, 默认为 /var/lib/docker 注意：此字段可能返回 null，表示取不到有效值。 示例值：/var/lib/docker
UserScript	String	否	base64 编码的用户脚本, 此脚本会在 k8s 组件运行后执行, 需要用户保证脚本的可重入及重试逻辑, 脚本及其生成的日志文件可在节点的 /data/ccs_userscript/ 路径查看, 如果要求节点需要在进行初始化完成后才可加入调度, 可配合 unschedulable 参数使用, 在 userScript 最后初始化完成后, 添加 kubectl uncordon nodename --kubeconfig=/root/.kube/config 命令使节点加入调度 注意：此字段可能返回 null，表示取不到有效值。 示例值：#!/bin/sh echo "hello world"
Unschedulable	Integer	否	设置加入的节点是否参与调度，默认值为0，表示参与调度；非0表示不参与调度, 待节点初始化完成之后, 可执行kubectl uncordon nodename使node加入调度. 示例值：false
Labels	Array of Label	否	节点Label数组 注意：此字段可能返回 null，表示取不到有效值。
DataDisks	Array of DataDisk	否	多盘数据盘挂载信息：新建节点时请确保购买CVM的参数传递了购买多个数据盘的信息，如CreateClusterInstances API的RunInstancesPara下的DataDisks也需要设置购买多个数据盘, 具体可以参考CreateClusterInstances接口的添加集群节点(多块数据盘)样例；添加已有节点时，请确保填写的分区信息在节点上真实存在 注意：此字段可能返回 null，表示取不到有效值。
ExtraArgs	InstanceExtraArgs	否	节点相关的自定义参数信息 注意：此字段可能返回 null，表示取不到有效值。

InstanceChargePrepaid

包年包月配置

被如下接口引用：CreateReservedInstances, RenewReservedInstances。

名称	类型	必选	描述
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_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。 示例值：NOTIFY_AND_MANUAL_RENEW

InstanceDataDiskMountSetting

CVM实例数据盘挂载配置

被如下接口引用：CreateCluster。

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

InstanceExtraArgs

节点自定义参数

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

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

InstanceUpgradeClusterStatus

节点升级过程中集群当前状态

被如下接口引用：GetUpgradeInstanceProgress。

名称	类型	描述
PodTotal	Integer	pod总数
NotReadyPod	Integer	NotReady pod总数

InstanceUpgradePreCheckResult

某个节点升级前检查结果

被如下接口引用：GetUpgradeInstanceProgress。

名称	类型	描述
CheckPass	Boolean	检查是否通过
Items	Array of InstanceUpgradePreCheckResultItem	检查项数组
SinglePods	Array of String	本节点独立pod列表

InstanceUpgradePreCheckResultItem

节点升级检查项结果

被如下接口引用：GetUpgradeInstanceProgress。

名称	类型	描述
Namespace	String	工作负载的命名空间
WorkLoadKind	String	工作负载类型
WorkLoadName	String	工作负载名称
Before	Integer	驱逐节点前工作负载running的pod数目
After	Integer	驱逐节点后工作负载running的pod数目
Pods	Array of String	工作负载在本节点上的pod列表

InstanceUpgradeProgressItem

某个节点的升级进度

被如下接口引用：GetUpgradeInstanceProgress。

名称	类型	描述
InstanceID	String	节点instanceID
LifeState	String	任务生命周期 process 运行中 paused 已停止 pauing 正在停止 done 已完成 timeout 已超时 aborted 已取消 pending 还未开始
StartAt	String	升级开始时间 注意：此字段可能返回 null，表示取不到有效值。
EndAt	String	升级结束时间 注意：此字段可能返回 null，表示取不到有效值。
CheckResult	InstanceUpgradePreCheckResult	升级前检查结果
Detail	Array of TaskStepInfo	升级步骤详情

KMSConfiguration

kms加密参数

被如下接口引用：EnableEncryptionProtection。

名称	类型	必选	描述
KeyId	String	否	kms id 示例值：38098f4c-f5ef-11ed-8c28-525400b4ad52
KmsRegion	String	否	kms 地域 示例值：ap-guangzhou

KubeJarvisStateCatalogue

集群巡检诊断的默认目录类型

被如下接口引用：DescribeClusterInspectionResultsOverview, ListClusterInspectionResults。

名称	类型	描述
CatalogueLevel	String	目录级别，支持参数： first：一级目录 second：二级目录 注意：此字段可能返回 null，表示取不到有效值。 示例值：first
CatalogueName	String	目录名 注意：此字段可能返回 null，表示取不到有效值。 示例值：quota

KubeJarvisStateDiagnostic

集群巡检诊断结果

被如下接口引用：ListClusterInspectionResults。

名称	类型	描述
StartTime	String	诊断开始时间 注意：此字段可能返回 null，表示取不到有效值。
EndTime	String	诊断结束时间 注意：此字段可能返回 null，表示取不到有效值。
Catalogues	Array of KubeJarvisStateCatalogue	诊断目录 注意：此字段可能返回 null，表示取不到有效值。
Type	String	诊断类型 注意：此字段可能返回 null，表示取不到有效值。
Name	String	诊断名称 注意：此字段可能返回 null，表示取不到有效值。
Desc	String	诊断描述 注意：此字段可能返回 null，表示取不到有效值。
Results	Array of KubeJarvisStateResultsItem	诊断结果列表 注意：此字段可能返回 null，表示取不到有效值。
Statistics	Array of KubeJarvisStateStatistic	诊断结果统计 注意：此字段可能返回 null，表示取不到有效值。

KubeJarvisStateDiagnosticOverview

集群巡检诊断概览

被如下接口引用：DescribeClusterInspectionResultsOverview。

名称	类型	描述
Catalogues	Array of KubeJarvisStateCatalogue	诊断目录 注意：此字段可能返回 null，表示取不到有效值。
Statistics	Array of KubeJarvisStateStatistic	诊断结果统计 注意：此字段可能返回 null，表示取不到有效值。

KubeJarvisStateInspectionOverview

集群巡检检查结果概览

被如下接口引用：DescribeClusterInspectionResultsOverview。

名称	类型	描述
ClusterId	String	集群ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：cls-dsffsd
Statistics	Array of KubeJarvisStateStatistic	诊断结果统计 注意：此字段可能返回 null，表示取不到有效值。
Diagnostics	Array of KubeJarvisStateDiagnosticOverview	诊断结果详情 注意：此字段可能返回 null，表示取不到有效值。

KubeJarvisStateInspectionResult

集群巡检检查结果

被如下接口引用：ListClusterInspectionResults。

名称	类型	描述
ClusterId	String	集群ID 注意：此字段可能返回 null，表示取不到有效值。
StartTime	String	诊断开始时间 注意：此字段可能返回 null，表示取不到有效值。
EndTime	String	诊断结束时间 注意：此字段可能返回 null，表示取不到有效值。
Statistics	Array of KubeJarvisStateStatistic	诊断结果统计 注意：此字段可能返回 null，表示取不到有效值。
Diagnostics	Array of KubeJarvisStateDiagnostic	诊断结果详情 注意：此字段可能返回 null，表示取不到有效值。
Error	String	查询巡检报告相关报错 注意：此字段可能返回 null，表示取不到有效值。

KubeJarvisStateInspectionResultsItem

集群巡检结果历史列表

被如下接口引用：ListClusterInspectionResultsItems。

名称	类型	描述
Name	String	巡检结果名称 注意：此字段可能返回 null，表示取不到有效值。
Statistics	Array of KubeJarvisStateStatistic	诊断结果统计 注意：此字段可能返回 null，表示取不到有效值。

KubeJarvisStateResultObjInfo

集群巡检诊断对象信息

被如下接口引用：ListClusterInspectionResults。

名称	类型	描述
PropertyName	String	对象属性名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：Name
PropertyValue	String	对象属性值 注意：此字段可能返回 null，表示取不到有效值。 示例值：pod-test

KubeJarvisStateResultsItem

集群巡检诊断结果详情信息

被如下接口引用：ListClusterInspectionResults。

名称	类型	描述
Level	String	诊断结果级别 注意：此字段可能返回 null，表示取不到有效值。 示例值：failed
ObjName	String	诊断对象名 注意：此字段可能返回 null，表示取不到有效值。 示例值：pod-xxx
ObjInfo	Array of KubeJarvisStateResultObjInfo	诊断对象信息 注意：此字段可能返回 null，表示取不到有效值。
Title	String	诊断项标题 注意：此字段可能返回 null，表示取不到有效值。 示例值：Master Capacity Check
Desc	String	诊断项描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：Master Capacity Check
Proposal	String	诊断建议 注意：此字段可能返回 null，表示取不到有效值。
ProposalDocUrl	String	诊断建议文档链接 注意：此字段可能返回 null，表示取不到有效值。
ProposalDocName	String	诊断建议文档名称 注意：此字段可能返回 null，表示取不到有效值。

KubeJarvisStateStatistic

集群巡检统计结果

被如下接口引用：DescribeClusterInspectionResultsOverview, ListClusterInspectionResults, ListClusterInspectionResultsItems。

名称	类型	描述
HealthyLevel	String	诊断结果的健康水平 注意：此字段可能返回 null，表示取不到有效值。 示例值：good
Count	Integer	诊断结果的统计 注意：此字段可能返回 null，表示取不到有效值。 示例值：2

Label

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

被如下接口引用：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。

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

LivenessOrReadinessProbe

健康探针

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

名称	类型	必选	描述
Probe	Probe	是	探针参数 注意：此字段可能返回 null，表示取不到有效值。
HttpGet	HttpGet	否	HttpGet检测参数 注意：此字段可能返回 null，表示取不到有效值。
Exec	Exec	否	容器内检测命令参数 注意：此字段可能返回 null，表示取不到有效值。
TcpSocket	TcpSocket	否	TcpSocket检测的端口参数 注意：此字段可能返回 null，表示取不到有效值。

LoginSettings

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

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

名称	类型	必选	描述
Password	String	否	实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下： Linux实例密码必须8到30位，至少包括两项[a-z]，[A-Z]、[0-9] 和 [( ) ` ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' , . ? / ]中的特殊符号。 Windows实例密码必须12到30位，至少包括三项[a-z]，[A-Z]，[0-9] 和 [( ) ` ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' , . ? /]中的特殊符号。 若不指定该参数，则由系统随机生成密码，并通过站内信方式通知到用户。 注意：此字段可能返回 null，表示取不到有效值。
KeyIds	Array of String	否	密钥ID列表。关联密钥后，就可以通过对应的私钥来访问实例；KeyId可通过接口DescribeKeyPairs获取，密钥与密码不能同时指定，同时Windows操作系统不支持指定密钥。 注意：此字段可能返回 null，表示取不到有效值。 示例值：["skey-3glfot13"]
KeepImageLogin	String	否	保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为true。取值范围： true：表示保持镜像的登录设置 false：表示不保持镜像的登录设置 默认取值：false。 注意：此字段可能返回 null，表示取不到有效值。 示例值：abc

ManuallyAdded

手动加入的节点

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

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

NfsVolume

EKS Instance Nfs Volume

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

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

NodeCountSummary

节点统计列表

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

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

NodePool

节点池描述

被如下接口引用：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，表示取不到有效值。

NodePoolOption

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

被如下接口引用：AddExistedInstances。

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

NodePoolRuntime

NodePool的运行时配置

被如下接口引用：ModifyClusterRuntimeConfig。

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

OIDCConfigAuthenticationOptions

OIDC认证相关配置

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

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

OpenConstraintInfo

策略实例信息

被如下接口引用：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"]

OpenPolicyInfo

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，表示取不到有效值。 示例值：[]

OpenPolicySwitch

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	否	策略关联的实例列表 示例值：[]

OptionalRuntimes

可选运行时

被如下接口引用：DescribeSupportedRuntime。

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

PendingRelease

应用市场安装的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，表示取不到有效值。

PodChargeInfo

Pod计费信息

被如下接口引用：DescribePodChargeInfo。

名称	类型	描述
StartTime	String	Pod计费开始时间 示例值："2021-07-13 23:06:43"
Uid	String	Pod的Uid 示例值："74425581-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名称

PodDeductionRate

可被预留券抵扣的 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

PodLimitsByType

某机型可支持的最大 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

PodLimitsInstance

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

被如下接口引用：DescribeVpcCniPodLimits。

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

PodNodeInfo

Pod所在的节点信息

被如下接口引用：DescribePodsBySpec。

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

Probe

健康检查探测参数

被如下接口引用：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，表示取不到有效值。

PrometheusAgentInfo

托管Prometheus agent信息

被如下接口引用：DeletePrometheusClusterAgent。

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

PrometheusAgentOverview

托管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

PrometheusAlertHistoryItem

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

PrometheusAlertManagerConfig

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

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

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

PrometheusAlertPolicyItem

托管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，表示取不到有效值。

PrometheusAlertRule

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，表示取不到有效值。

PrometheusAlertRuleDetail

托管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

PrometheusClusterAgentBasic

与云监控融合托管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代表采集默认指标

PrometheusClusterAgentPodConfig

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

被如下接口引用：CreatePrometheusClusterAgent。

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

PrometheusConfigItem

prometheus配置

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

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

PrometheusGrafanaInfo

托管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

PrometheusInstanceOverview

托管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

PrometheusInstancesOverview

托管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

PrometheusJobTargets

prometheus一个job的targets

被如下接口引用：DescribePrometheusTargets。

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

PrometheusNotification

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，表示取不到有效值。

PrometheusNotificationItem

告警通知渠道配置

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

名称	类型	必选	描述
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，表示取不到有效值。

PrometheusRecordRuleYamlItem

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

被如下接口引用：DescribePrometheusRecordRules。

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

PrometheusTarget

prometheus一个抓取目标的信息

被如下接口引用：DescribePrometheusTargets。

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

PrometheusTemp

模板实例

被如下接口引用：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，表示取不到有效值。

PrometheusTempModify

云原生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，表示取不到有效值。

PrometheusTemplate

模板实例

被如下接口引用：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，表示取不到有效值。

PrometheusTemplateModify

云原生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，表示取不到有效值。

PrometheusTemplateSyncTarget

云原生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，表示取不到有效值。

RIUtilizationDetail

预留券抵扣详情

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

RegionInstance

地域属性信息

被如下接口引用：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，表示取不到有效值。 示例值：广州地域

Release

应用市场部署的应用结构

被如下接口引用：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，表示取不到有效值。

ReleaseDetails

应用市场的安装应用详情

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

ReleaseHistory

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

被如下接口引用：DescribeClusterReleaseHistory。

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

ReleaseValues

应用市场自定义参数

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

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

ReservedInstance

预留实例

被如下接口引用：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-12345678
NodeName	String	节点名称 示例值：eklet-subnet-12345678
DeductStatus	String	上个周期预留券的抵扣状态，Deduct、NotDeduct 示例值：Deduct

ReservedInstanceScope

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

被如下接口引用：ModifyReservedInstanceScope。

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

ReservedInstanceSpec

预留券规格

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

ReservedInstanceUtilizationRate

预留券的使用率信息

被如下接口引用：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-12345678
NodeName	String	节点名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：eklet-subnet-12345678
PodNum	Integer	Pod 数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：1

ResourceDeleteOption

资源删除选项

被如下接口引用：DeleteCluster。

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

ResourceUsage

集群资源使用量

被如下接口引用：DescribeResourceUsage。

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

ResourceUsageDetail

资源使用明细

被如下接口引用：DescribeResourceUsage。

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

RouteInfo

集群路由对象

被如下接口引用：DescribeClusterRoutes。

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

RouteTableConflict

路由表冲突对象

被如下接口引用：DescribeRouteTableConflicts。

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

RouteTableInfo

集群路由表对象

被如下接口引用：DescribeClusterRouteTables。

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

RunAutomationServiceEnabled

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

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

名称	类型	必选	描述
Enabled	Boolean	否	是否开启云自动化助手。取值范围： true：表示开启云自动化助手服务 false：表示不开启云自动化助手服务 默认取值：false。 示例值：true

RunInstancesForNode

不同角色的节点配置参数

被如下接口引用：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生效）。

RunMonitorServiceEnabled

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

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

名称	类型	必选	描述
Enabled	Boolean	否	是否开启云监控服务。取值范围： true：表示开启云监控服务 false：表示不开启云监控服务 默认取值：true。 注意：此字段可能返回 null，表示取不到有效值。 示例值：true

RunSecurityServiceEnabled

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

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

名称	类型	必选	描述
Enabled	Boolean	否	是否开启云安全服务。取值范围： true：表示开启云安全服务 false：表示不开启云安全服务 默认取值：true。 示例值：false

RuntimeConfig

运行时配置

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

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

ScaleInMaster

master节点缩容参数

被如下接口引用：ScaleInClusterMaster。

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

SecurityContext

cloudrun安全特性

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

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

ServiceAccountAuthenticationOptions

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

Step

执行步骤信息

被如下接口引用：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"

SubnetInfos

子网信息

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

SuperNodeResource

超级节点上的资源统计

被如下接口引用：DescribePostNodeResources。

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

Switch

集群日志开关集合

被如下接口引用：DescribeLogSwitches。

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

SwitchInfo

日志开关详细信息

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

Tag

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

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

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

TagSpecification

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

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

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

Taint

kubernetes Taint

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

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

TaskStepInfo

任务步骤信息

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

探针使用TcpSocket检测容器

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

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

Toleration

kubernetes Taint

被如下接口引用：CreatePrometheusClusterAgent。

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

UnavailableReason

不可用原因

被如下接口引用：CheckInstancesUpgradeAble。

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

UpgradeAbleInstancesItem

可升级节点信息

被如下接口引用：CheckInstancesUpgradeAble。

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

UpgradeNodeResetParam

节点升级重装参数

被如下接口引用：UpgradeClusterInstances。

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

VersionInstance

版本信息

被如下接口引用：DescribeVersions。

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

VirtualNode

虚拟节点

被如下接口引用：DescribeClusterVirtualNode。

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

VirtualNodePool

虚拟节点池

被如下接口引用：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，表示取不到有效值。

VirtualNodeSpec

超级节点

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

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

VolumeMount

数据卷挂载路径信息

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

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