租户端 计算 容器服务（TKE） 数据结构

数据结构

最近更新时间: 2024-10-18 10:38:36

LogTopic

日志主题

被如下接口引用：DescribeClsLogTopics

名称 必选 允许NULL 类型 描述
LogSetId 是 否 String 日志集ID
TopicId 是 否 String 日志主题ID
TopicName 是 否 String 日志主题名称
Path 是 否 String 路径
CreateTime 是 否 String 创建时间
LogType 是 否 String 日志类型
Collection 是 否 Bool 是否采集
Index 是 否 Bool 是否有索引

DescribeLogSwitchInfo

DescribeLogSwitchInfo

被如下接口引用：DescribeLogSwitches

名称 必选 允许NULL 类型 描述
Enable 是 是 Bool 是否开启
LogsetId 是 是 String 日志集ID
TopicId 是 是 String 日志主题ID

VersionInstance

版本信息

被如下接口引用：DescribeVersions

名称 必选 允许NULL 类型 描述
Name 是 是 String 版本名称
Version 是 是 String 版本信息
Remark 是 是 String Remark

Cluster

集群信息结构体

被如下接口引用：DescribeClusters

名称 必选 允许NULL 类型 描述
ClusterId 是 否 String 集群ID
ClusterName 是 否 String 集群名称
ClusterDescription 是 否 String 集群描述
ClusterVersion 是 否 String 集群版本（默认值为1.10.5）
ClusterOs 是 否 String 集群系统。centos7.2x86_64 或者 ubuntu16.04.1 LTSx86_64，默认取值为ubuntu16.04.1 LTSx86_64
ClusterType 是 否 String 集群类型，托管集群：MANAGED_CLUSTER，独立集群：INDEPENDENT_CLUSTER。
ClusterNetworkSettings 是 否 ClusterNetworkSettings 集群网络相关参数
ClusterNodeNum 是 否 Uint64 集群当前node数量
ProjectId 是 否 Uint64 集群所属的项目ID
TagSpecification 是 是 Array of TagSpecification 标签描述列表。
ClusterStatus 是 否 String 集群状态 (Running 运行中 Creating 创建中 Abnormal 异常 )
Property 是 是 String 集群属性(包括集群不同属性的MAP，属性字段包括NodeNameType (lan-ip模式和hostname 模式，默认无lan-ip模式))
ClusterMaterNodeNum 是 否 Uint64 集群当前master数量
ImageId 是 是 String 集群使用镜像id
OsCustomizeType 是 是 String OsCustomizeType
ContainerRuntime 是 是 String 集群运行环境docker或container
CreatedTime 是 是 String 创建时间
ClusterArch 是 是 String 创建的集群架构,取值: X86/ARM
DirectAccess 否 是 String pod直通模式
ClusterOsAlias 否 是 String 集群操作系统名称
IsDualStack 否 是 String 是否为双栈集群
Ipv6ServiceCidr 否 是 String Ipv6 Service Cidr

HostNameValue

节点主机名称结构

被如下接口引用：CheckClusterHostName

名称 必选 允许NULL 类型 描述
Name 是 否 String 主机名称
Value 是 否 Uint64 主机数量

LoginSettings

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

被如下接口引用：AddExistedInstances、UpgradeClusterInstances

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

ZoneResource

可用区资源

被如下接口引用：

名称 必选 允许NULL 类型 描述
Zone 否 否 String 可用区
TotalCount 否 否 Int64 可创建的规格总数

ClusterInternalLB

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

被如下接口引用：

名称 必选 允许NULL 类型 描述
Enabled 是 否 Bool 是否开启内网访问LB
SubnetId 否 否 String 内网访问LB关联的子网Id

Label

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

被如下接口引用：AddExistedInstances、CreateCluster、CreateClusterAsGroup、CreateClusterInstances、CreateClusterVirtualNodePool、CreateIndependentCluster、CreateLogCollector、CreateTKECluster、DescribeClusterAsGroups、DescribeClusterInstances、DescribeClusterVirtualNodePools、GetLogCollector、ListLogCollector、ModifyClusterVirtualNodePool、UpdateClusterInstances、UpdateLogCollector、UpgradeClusterInstances

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

SubnetResource

SubnetResource

被如下接口引用：

名称 必选 允许NULL 类型 描述
CPU 是 否 Float cpu
Memory 是 否 Float mem
PodNum 是 否 Int64 pod数量
SubnetId 是 否 String 子网ID

InstanceUpgradePreCheckResultItem

节点升级检查项结果

被如下接口引用：GetUpgradeInstanceProgress

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

DataDisk

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

被如下接口引用：AddExistedInstances、CreateCluster、CreateClusterAsGroup、CreateClusterInstances、CreateIndependentCluster、CreateTKECluster、DescribeClusterInstances、UpdateClusterInstances、UpgradeClusterInstances

名称 必选 允许NULL 类型 描述
DiskType 是 否 String 云盘类型
FileSystem 是 否 String 文件系统(ext3/ext4/xfs)
DiskSize 是 否 Int64 云盘大小(G）
AutoFormatAndMount 是 否 Bool 是否自动化格式盘并挂载
MountTarget 否 否 String 挂载目录

DeletePolicyInfo

删除策略结构体

被如下接口引用：

名称 必选 允许NULL 类型 描述
Id 是 否 Uint64 策略ID
TopicId 是 否 String AMP系统主题ID
AlarmPolicyType 是 否 String 策略类型
ArgusPolicyIds 是 否 Array of Uint64 ARGUS系统策略ID列表

CertificateInfo

客户证书信息

被如下接口引用：ListClusterCertificates

名称 必选 允许NULL 类型 描述
Kubeconfig 是 否 String kubeconfig信息
CertificateStatus 是 否 String 证书状态
ClientCertificate 是 否 String 证书certificate
ClientKey 是 否 String 证书key
NickName 是 否 String 对应用户的昵称
SubAccountUin 是 否 String 用户的uin
ExpirationTime 是 否 Datetime_iso 证书过期时间

SimplePodInfo

驱逐节点返回值

被如下接口引用：DrainClusterNode、DrainClusterVirtualNode

名称 必选 允许NULL 类型 描述
Name 是 否 String pod名称
Namespace 是 否 String pod所属命名空间
NodeIp 是 否 String 所属节点IP

ImageAttributeSet

unImgId到deviceImageId的映射的数组

被如下接口引用：

名称 必选 允许NULL 类型 描述
ImageId 是 否 String 镜像id
InnerImageId 是 否 Uint64 内部镜像id

File

文件

被如下接口引用：DescribeHelmChartDetail

名称 必选 允许NULL 类型 描述
Data 否 是 String 数据
Name 否 是 String 名称

PodDetail

EKS pod 信息

被如下接口引用：

名称 必选 允许NULL 类型 描述
EksId 否 否 String pod唯一ID
ClusterId 否 否 String 集群ID
Namespace 否 否 String 命名空间
Kind 否 否 String 工作负载类型
KindName 否 否 String 工作负载名称
Name 否 否 String pod名称
Uid 否 否 String pod的uid
RecordTime 否 否 String 记录时间

RegionInstance

地域属性信息

被如下接口引用：DescribeRegions

名称 必选 允许NULL 类型 描述
RegionName 是 是 String 地域名称
RegionId 是 是 Int64 地域ID
Status 是 是 String 地域状态
FeatureGates 是 是 String 地域特性开关(按照JSON的形式返回所有属性)
Alias 是 是 String 地域简称
Remark 是 是 String 地域白名单

RunInstancesForNode

不同角色的节点配置参数

被如下接口引用：CreateCluster、CreateIndependentCluster、CreateTKECluster

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

EnhancedService

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

被如下接口引用：AddExistedInstances、UpgradeClusterInstances

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

CcnRoute

用于查询/添加/删除集群cidr到云联网

被如下接口引用：AddClusterCIDRToCcn、AddClusterCIDRToVbc、DeleteClusterCIDRFromCcn、DeleteClusterCIDRFromVbc、DescribeCcnRoutes、GetVbcInstance、GetVbcRoute

名称 必选 允许NULL 类型 描述
RouteId 是 是 String 路由策略ID
DestinationCidrBlock 是 是 String 目的端
InstanceType 是 是 String 下一跳类型（关联实例类型），所有类型：VPC、DIRECTCONNECT
InstanceId 是 是 String 下一跳（关联实例）
InstanceRegion 是 是 String 下一跳所属地域（关联实例所属地域）
InstanceUin 是 是 String 关联实例所属UIN（根账号）

fileEntry

chart返回值

被如下接口引用：DescribeHelmChartDetail

名称 必选 允许NULL 类型 描述
Name 是 是 String 名称
Value 否 是 String chart值
ID 否 是 Int64 id
Children 否 是 Array of FileEntry fileEntry

ContainerEnvs

ContainerEnvs

被如下接口引用：

名称 必选 允许NULL 类型 描述
Name 否 否 String 名称
InitContainer 否 否 Bool 是否initContainer
Envs 否 否 Array of EnvironmentVariable 环境变量

InstanceUpgradePreCheckResult

某个节点升级前检查结果

被如下接口引用：GetUpgradeInstanceProgress

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

AlarmPolicyFilter

告警策略过滤

被如下接口引用：DescribeAlarmPolicies

名称 必选 允许NULL 类型 描述
AlarmPolicyName 是 否 String 告警策略名称

ClusterHealthyPodsStatus

集群健康检查中pod的健康情况

被如下接口引用：DescribeClusterHealthyStatus

名称 必选 允许NULL 类型 描述
Total 是 否 Int64 pod总数
NotReadyTotal 是 否 Int64 NotReady的pod总数
NotReadyPods 是 是 Array of NotReadyPodsItem NotReady的pod详细信息

LogOutputOption

日志收集输出选项

被如下接口引用：CreateLogCollector、GetLogCollector、ListLogCollector、UpdateLogCollector

名称 必选 允许NULL 类型 描述
InstanceId 否 是 String 实例id
TopicId 否 是 String topicID
Host 否 是 String 主机hsot
Port 否 是 String 端口
Topic 否 是 String topic
LogsetId 否 是 String LogsetId

ClusterStatus

集群状态信息

被如下接口引用：DescribeClusterStatus

名称 必选 允许NULL 类型 描述
ClusterId 是 否 String 集群Id
ClusterState 是 否 String 集群状态
ClusterInstanceState 是 否 String 集群下机器实例的状态
ClusterBMonitor 是 否 Bool 集群是否开启监控
ClusterInitNodeNum 是 否 Int64 集群创建中的节点数，-1表示获取节点状态超时，-2表示获取节点状态失败
ClusterRunningNodeNum 是 否 Int64 集群运行中的节点数，-1表示获取节点状态超时，-2表示获取节点状态失败
ClusterFailedNodeNum 是 否 Int64 集群异常的节点数，-1表示获取节点状态超时，-2表示获取节点状态失败
ClusterClosedNodeNum 是 是 Int64 集群已关机的节点数，-1表示获取节点状态超时，-2表示获取节点状态失败
ClusterClosingNodeNum 是 是 Int64 集群关机中的节点数，-1表示获取节点状态超时，-2表示获取节点状态失败

ReservedInstance

预留实例

被如下接口引用：

名称 必选 允许NULL 类型 描述
ReservedInstanceId 否 否 String 预留实例ID
ReservedInstanceName 否 否 String 预留实例名称
Status 否 否 String 预留券状态
TimeSpan 否 否 Uint64 有效期，单位：月
ResourceType 否 否 String 抵扣资源类型
Cpu 否 否 Float 资源核数
Memory 否 否 Float 资源内存，单位：Gi
Scope 否 否 String 预留券的范围，默认值region。
CreatedAt 否 否 String 创建时间
ActiveAt 否 否 String 生效时间
ExpireAt 否 否 String 过期时间

ExistedInstance

已经存在的实例信息

被如下接口引用：DescribeExistedInstances

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

RouteTableInfo

集群路由表对象

被如下接口引用：DescribeClusterRouteTables

名称 必选 允许NULL 类型 描述
RouteTableName 是 否 String 路由表名称。
RouteTableCidrBlock 是 否 String 路由表CIDR。
VpcId 是 否 String VPC实例ID。

InspectionReportItem

健康检查结果项目

被如下接口引用：DescribeClusterInspectionReport

名称 必选 允许NULL 类型 描述
Name 是 否 String 名称
Error 是 否 String 错误信息

RouteTableConflict

路由表冲突对象

被如下接口引用：DescribeRouteTableConflicts

名称 必选 允许NULL 类型 描述
RouteTableType 是 否 String 路由表类型。
RouteTableCidrBlock 是 是 String 路由表CIDR。
RouteTableName 是 是 String 路由表名称。
RouteTableId 是 是 String 路由表ID。

SecretVolume

SecretVolume

被如下接口引用：

名称 必选 允许NULL 类型 描述
Data 否 是 Array of KeyValueData secret
Type 否 是 String type

InstanceAdvancedSettings

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

被如下接口引用：AddExistedInstances、CreateCluster、CreateClusterAsGroup、CreateClusterInstances、CreateIndependentCluster、CreateTKECluster、DescribeClusterInstances、UpdateClusterInstances、UpgradeClusterInstances

名称 必选 允许NULL 类型 描述
MountTarget 否 是 String 数据盘挂载点, 默认不挂载数据盘. 已格式化的 ext3，ext4，xfs 文件系统的数据盘将直接挂载，其他文件系统或未格式化的数据盘将自动格式化为ext4 并挂载，请注意备份数据! 无数据盘或有多块数据盘的云主机此设置不生效。
DockerGraphPath 否 是 String dockerd --graph 指定值, 默认为 /var/lib/docker
UserScript 否 是 String base64 编码的用户脚本, 此脚本会在 k8s 组件运行后执行, 需要用户保证脚本的可重入及重试逻辑, 脚本及其生成的日志文件可在节点的 /data/ccs_userscript/ 路径查看, 如果要求节点需要在进行初始化完成后才可加入调度, 可配合 unschedulable 参数使用, 在 userScript 最后初始化完成后, 添加 kubectl uncordon nodename --kubeconfig=/root/.kube/config 命令使节点加入调度
Unschedulable 否 是 Int64 设置加入的节点是否参与调度，默认值为0，表示参与调度；非0表示不参与调度, 待节点初始化完成之后, 可执行kubectl uncordon nodename使node加入调度.
Labels 否 是 Array of Label 节点Label数组
DataDisks 否 是 Array of DataDisk 数据盘相关信息
ExtraArgs 否 是 InstanceExtraArgs 节点相关的自定义参数信息
PreStartUserScript 否 是 String base64 编码的用户脚本, 此脚本会在 k8s 组件运行前执行, 需要用户保证脚本的可重入及重试逻辑, 脚本及其生成的日志文件可在节点的 /data/ccs_userscript/ 路径查看.

LogInputOption

日志输入描述

被如下接口引用：CreateLogCollector、GetLogCollector、ListLogCollector、UpdateLogCollector

名称 必选 允许NULL 类型 描述
Path 否 否 String 路径
Labels 否 否 Label 标签 类型为map 键值对
AllNamespaces 否 否 Bool 是否是全部命名空间
Namespaces 否 否 LogInputOptNamespace 命名空间

RunMonitorServiceEnabled

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

被如下接口引用：AddExistedInstances、UpgradeClusterInstances

名称 必选 允许NULL 类型 描述
Enabled 否 否 Bool 是否开启云监控服务。取值范围：<br><li>TRUE：表示开启云监控服务<br><li>FALSE：表示不开启云监控服务<br><br>默认取值：TRUE。

ClusterDefinition

集群环境相关的参数

被如下接口引用：

名称 必选 允许NULL 类型 描述
RegionId 是 否 Uint64 集群地域信息
ProjectId 是 否 Int64 项目ID（已经废弃）
MasterLBSubnetId 是 否 String 集群Mater的LB所在的SubnetId

ServiceAccountVolume

ServiceAccountVolume

被如下接口引用：

名称 必选 允许NULL 类型 描述
Data 否 否 Array of KeyValueData data

ClusterAsGroupAttribute

集群伸缩组属性

被如下接口引用：ModifyClusterAsGroupAttribute

名称 必选 允许NULL 类型 描述
AutoScalingGroupId 是 否 String 伸缩组ID
AutoScalingGroupEnabled 否 否 Bool 是否开启，伸缩组启用停用的时候需要
AutoScalingGroupRange 否 否 AutoScalingGroupRange 伸缩组最大最小实例数，调整伸缩组配置的时候需要

MachineGroup

机器组

被如下接口引用：

名称 必选 允许NULL 类型 描述
GroupId 是 是 String 机器组ID
GroupName 是 否 String 机器组名称

PayLoad

configmap 数据键值对

被如下接口引用：

名称 必选 允许NULL 类型 描述
Data 是 否 String configmap base64 encoded data
Key 是 否 String configmap file user visible path

RIUtilizationDetail

预留券抵扣详情

被如下接口引用：

名称 必选 允许NULL 类型 描述
ReservedInstanceId 否 否 String 预留券ID
EksId 否 否 String Pod唯一ID
ClusterId 否 否 String 集群ID
Name 否 否 String Pod的名称
Namespace 否 否 String Pod的命名空间
Kind 否 否 String 工作负载类型
KindName 否 否 String 工作负载名称
Uid 否 否 String Pod的uid
StartTime 否 否 String 用量开始时间
EndTime 否 否 String 用量结束时间
Product 否 否 String 抵扣资源所属产品

TencentCbsVolume

TencentCbsVolume

被如下接口引用：

名称 必选 允许NULL 类型 描述
DiskId 否 否 String cbs id
FsType 否 否 String fs类型
ReadOnly 否 否 Bool 是否只读

ContainerStatus

容器状态描述信息

被如下接口引用：DescribeClusterPods

名称 必选 允许NULL 类型 描述
Name 是 否 String 容器名称
ContainerId 是 否 String 容器ID
Status 是 否 String 容器状态
Reason 是 否 String 容器处于该状态的原因
Image 是 否 String 容器镜像ID

AddExistInstancesParam

添加已有节点

被如下接口引用：

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

ClusterAsGroupOption

集群弹性伸缩配置

被如下接口引用：DescribeClusterAsGroupOption、ModifyClusterAsGroupOptionAttribute

名称 必选 允许NULL 类型 描述
IsScaleDownEnabled 是 否 Bool 是否开启缩容
Expander 是 否 String 多伸缩组情况下扩容选择算法(random 随机选择，most-pods 最多类型的Pod least-waste 最少的资源浪费，默认为random)
MaxEmptyBulkDelete 否 是 Int64 最大并发缩容数
ScaleDownDelay 否 是 Int64 集群扩容后多少分钟开始判断缩容（默认为10分钟）
ScaleDownUnneededTime 否 是 Int64 节点连续空闲多少分钟后被缩容（默认为 10分钟）
ScaleDownUtilizationThreshold 否 是 Int64 节点资源使用量低于多少(百分比)时认为空闲(默认: 50(百分比))
SkipNodesWithLocalStorage 否 是 Bool 含有本地存储Pod的节点是否不缩容(默认： FALSE)
SkipNodesWithSystemPods 否 是 Bool 含有kube-system namespace下非DaemonSet管理的Pod的节点是否不缩容 (默认： FALSE)
IgnoreDaemonSetsUtilization 否 是 Bool 计算资源使用量时是否默认忽略DaemonSet的实例(默认值: False，不忽略)
MaxTotalUnreadyPercentage 否 是 Int64 unready节点最大占比
OkTotalUnreadyCount 否 是 Int64 unready节点累计数量
ScaleDownUnreadyTime 否 是 Int64 unready节点缩容时间
UnregisteredNodeRemovalTime 否 是 Int64 未注册成功节点移除耗时

ClusterInstancesVersionItem

集群中某个版本的worker节点数目

被如下接口引用：DescribeInstancesVersion

名称 必选 允许NULL 类型 描述
InstanceVersion 是 否 String 版本
Total 是 否 Uint64 节点数
UpgradeAble 是 是 Bool 是否可升级

HPAInfo

HPA信息

被如下接口引用：

名称 必选 允许NULL 类型 描述
MaxReplica 是 是 Int64 最大副本数
MinReplica 是 是 Int64 最小副本数
Metricss 是 是 Array of ScaleMetrics 伸缩指标数组

UpgradeAbleInstancesItem

可升级节点信息

被如下接口引用：CheckInstancesUpgradeAble

名称 必选 允许NULL 类型 描述
InstanceId 是 否 String 节点Id
Version 是 否 String 节点的当前版本

CcnInstance

云联网实例

被如下接口引用：DescribeCcnInstances

名称 必选 允许NULL 类型 描述
CcnId 是 是 String 云联网实例ID
InstanceType 是 是 String 关联实例类型：VPC：私有网络DIRECTCONNECT：专线网关BMVPC：黑石私有网络
InstanceId 是 是 String 关联实例ID
InstanceRegion 是 是 String 关联实例所属大区，例如：ap-guangzhou
InstanceUin 是 是 String 关联实例所属UIN（根账号
Cidrs 是 是 Array of String 关联实例CIDR
State 是 是 String 关联实例状态：PENDING：申请中ACTIVE：已连接EXPIRED：已过期REJECTED：已拒绝DELETED：已删除FAILED：失败的（2小时后将异步强制解关联）ATTACHING：关联中DETACHING：解关联中DETACHFAILED：解关联失败（2小时后将异步强制解关联）
CcnUin 是 是 String 云联网所属UIN（根账号）

Flag

参数描述

被如下接口引用：DescribeClusterAvailableExtraArgs

名称 必选 允许NULL 类型 描述
Name 是 否 String 参数名
Type 是 否 String 参数类型
Usage 是 否 String 参数描述
Default 是 否 String 参数默认值
Constraint 是 否 String 参数可选范围（目前包含range和in两种，"[]"代表range，如"[1, 5]"表示参数必须>=1且 <=5, "()"代表in， 如"('aa', 'bb')"表示参数只能为字符串'aa'或者'bb'，该参数为空表示不校验）

DescribeClusterInspectionItem

描述集群巡检概览信息

被如下接口引用：DescribeClusterInspections

名称 必选 允许NULL 类型 描述
ClusterId 是 否 String 集群实例id
Error 是 是 String 如果发生错误，则该字段包含错误信息
Progress 是 是 ClusterInspectionProgress 如果当前正在巡检，则该字段包含检测巡检
LastResult 是 是 ClusterInspectionOverview 最近一次巡检结果概览
Cron 是 是 String 自动巡检周期，crontab格式

TKEEdgeNodeResources

边缘集群节点资源详情

被如下接口引用：

名称 必选 允许NULL 类型 描述
CPU 是 是 Float 节点cpu配置
Memory 是 是 Float 节点memory配置

AlarmPolicy

告警策略结构体

被如下接口引用：DescribeAlarmPolicies

名称 必选 允许NULL 类型 描述
AlarmPolicyId 是 否 String 告警策略ID
ClusterInstanceId 是 否 String k8s集群ID
Namespace 是 是 String k8s命名空间
WorkloadType 是 是 String k8s工作负载类型
AlarmPolicySettings 是 否 AlarmPolicySettings 告警策略settings
NotifySettings 是 否 NotifySettings 告警通知settings
ShieldSettings 是 否 ShieldSettings 告警屏蔽settings

Result

Result

被如下接口引用：DescribeHelmChartVersion

名称 必选 允许NULL 类型 描述
Chart 否 是 String chart
Name 否 是 String 名称
Score 否 是 Int64 分数

ClusterInspectionOverview

集群巡检一次检测的概览

被如下接口引用：DescribeClusterInspectionOverviews、DescribeClusterInspections

名称 必选 允许NULL 类型 描述
Id 是 否 String 本次检查的id，用于与其他检测结果区分
StartTime 是 否 String 检查的时间
Error 是 是 String 如果检查异常终止，则该字段包含错误信息
Statistic 是 是 InspectionStatistic 统计信息

RunClusterInspectionResponseItem

触发集群巡检请求返回

被如下接口引用：RunClusterInspections

名称 必选 允许NULL 类型 描述
ClusterId 是 否 String 集群实例id
Error 是 是 String 如果请求未能正常被处理，则Error中将包含错误信息

TaskStepInfo

任务步骤信息

被如下接口引用：DescribeUpgradeClusterProgress、GetUpgradeClusterProgress、GetUpgradeInstanceProgress

名称 必选 允许NULL 类型 描述
Step 是 是 String 步骤名称
LifeState 是 否 String 生命周期pending : 步骤未开始running: 步骤执行中success: 步骤成功完成failed: 步骤失败
StartAt 是 是 String 步骤开始时间
EndAt 是 是 String 步骤结束时间
FailedMsg 是 是 String 若步骤生命周期为failed,则此字段显示错误信息
InstanceID 否 否 String 实例ID(仅节点升级使用)

ClusterNetworkSettings

集群网络相关的参数

被如下接口引用：DescribeClusters

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

InstanceExtraArgs

节点自定义参数

被如下接口引用：AddExistedInstances、CreateCluster、CreateClusterAsGroup、CreateClusterInstances、CreateIndependentCluster、CreateTKECluster、DescribeClusterInstances、UpdateClusterInstances、UpgradeClusterInstances

名称 必选 允许NULL 类型 描述
Kubelet 否 是 Array of String kubelet自定义参数

ImageRegistryCredential

ImageRegistryCredential

被如下接口引用：

名称 必选 允许NULL 类型 描述
Server 否 否 String 地址
Username 否 否 String user
Password 否 否 String pass

前台Banner展示

被如下接口引用：

名称 必选 允许NULL 类型 描述
Id 是 否 Int64 序号
Content 是 否 String 展示内容
Tags 是 否 String 展示页面

Step

执行步骤信息

被如下接口引用：DescribeClusterCreateProgress

名称 必选 允许NULL 类型 描述
Type 是 否 String 名称
LastProbeTime 是 否 String 最后一次执行时间
Status 是 否 String 当前状态
Message 是 否 String 执行信息

ChargeInfo

Pod计费信息

被如下接口引用：

名称 必选 允许NULL 类型 描述
Charge 否 否 Bool pod是否计费
StartTime 否 否 String pod计费开始时间
Uid 否 否 String Pod的Uid

AlarmMetric

告警指标结构体

被如下接口引用：AddAlarmPolicy、DescribeAlarmPolicies、ModifyAlarmPolicy

名称 必选 允许NULL 类型 描述
MetricId 否 否 String 告警指标ID
Measurement 否 否 String ARGUS系统Measurement
StatisticsPeriod 否 否 Int64 统计周期
MetricName 否 否 String 指标名
ArgusPolicyName 是 否 String 指标描述
Evaluator 是 否 Evaluator 告警判断设置
ContinuePeriod 是 否 Int64 持续周期
Status 是 否 Bool 状态，true表示OK
Unit 否 是 String 指标单位

Chart

chart列表

被如下接口引用：DescribeHelmChartDetail

名称 必选 允许NULL 类型 描述
Files 否 是 Array of File 文件列表
Lock 否 是 String Lock
Metadata 否 是 Metadata metadata
Schema 否 是 String Schema
Templates 否 是 Array of File Templates
Values 否 是 String Values

ClusterCIDRSettings

集群容器网络相关参数

被如下接口引用：CreateCluster、CreateIndependentCluster、CreateTKECluster

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

InstanceUpgradeProgressItem

某个节点的升级进度

被如下接口引用：GetUpgradeInstanceProgress

名称 必选 允许NULL 类型 描述
InstanceID 是 否 String 节点instanceID
LifeState 是 否 String 任务生命周期process 运行中paused 已停止pauing 正在停止done 已完成timeout 已超时aborted 已取消pending 还未开始
StartAt 是 是 String 升级开始时间
EndAt 是 是 String 升级结束时间
CheckResult 是 否 InstanceUpgradePreCheckResult 升级前检查结果
Detail 是 否 Array of TaskStepInfo 升级步骤详情

NotifySettings

告警通知settings

被如下接口引用：AddAlarmPolicy、DescribeAlarmPolicies、ModifyAlarmPolicy

名称 必选 允许NULL 类型 描述
ReceiverGroups 是 否 Array of Int64 告警接收组（用户组）
NotifyWay 是 否 Array of String 告警通知方式。目前有SMS、EMAIL、CALL、WECHAT方式。分别代表：短信、邮件、电话、微信
PhoneNotifyOrder 否 是 Array of Int64 电话告警顺序。注：NotifyWay选择CALL，采用该参数。
PhoneCircleTimes 否 是 Int64 电话告警次数。注：NotifyWay选择CALL，采用该参数。
PhoneInnerInterval 否 是 Int64 电话告警轮内间隔。单位：秒注：NotifyWay选择CALL，采用该参数。
PhoneCircleInterval 否 是 Int64 电话告警轮外间隔。单位：秒注：NotifyWay选择CALL，采用该参数。
PhoneArriveNotice 否 是 Int64 电话告警触达通知注：NotifyWay选择CALL，采用该参数。

ResourceStatusItem

资源状态

被如下接口引用：DescribeClustersResourceStatus

名称 必选 允许NULL 类型 描述
Dimension 是 否 String 维度
TotalNum 是 否 Uint64 总数
AbnormalNum 是 否 Uint64 异常数
AbnormalDetail 是 否 Array of AbnormalDetail 异常详情

ClusterExtraArgs

集群master自定义参数

被如下接口引用：CreateCluster、CreateIndependentCluster、CreateTKECluster、DescribeClusterExtraArgs、UpdateClusterVersion

名称 必选 允许NULL 类型 描述
KubeAPIServer 否 是 Array of String kube-apiserver自定义参数
KubeControllerManager 否 是 Array of String kube-controller-manager自定义参数
KubeScheduler 否 是 Array of String kube-scheduler自定义参数

K8SVersions

K8SVersions

被如下接口引用：

名称 必选 允许NULL 类型 描述
Name 是 否 String 组件名
Version 是 否 String 组件版本
Status 是 是 String 状态
Remark 是 是 String 描述

NodePool

节点池

被如下接口引用：

名称 必选 允许NULL 类型 描述
NodePoolId 是 否 String NodePoolId
Name 是 否 String Name
ClusterInstanceId 是 否 String ClusterInstanceId
LifeState 是 否 String LifeState
LaunchConfigurationId 是 否 String LaunchConfigurationId
AutoscalingGroupId 是 否 String AutoscalingGroupId
Labels 是 否 Array of Label Labels
Taints 是 否 Array of Taint Taints

InspectionStatistic

InspectionStatistic

被如下接口引用：DescribeClusterInspectionOverviews、DescribeClusterInspections

名称 必选 允许NULL 类型 描述
GoodItem 是 否 Uint64 GoodItem
WarnItem 是 否 Uint64 WarnItem
RiskItem 是 否 Uint64 RiskItem
SeriousItem 是 否 Uint64 SeriousItem
FailedItem 是 否 Uint64 FailedItem

CommonNames

用于返回入参列表中请求对应的子用户的CommonName

被如下接口引用：DescribeClusterCommonNames

名称 必选 允许NULL 类型 描述
CN 是 否 String 对应commonName
SubaccountUin 是 否 String 子账户id

Instance

集群的实例信息

被如下接口引用：DescribeClusterInstances

名称 必选 允许NULL 类型 描述
InstanceId 是 否 String 实例ID
InstanceRole 是 否 String 节点角色, MASTER, WORKER, ETCD, MASTER_ETCD,ALL, 默认为WORKER
FailedReason 是 否 String 实例异常(或者处于初始化中)的原因
InstanceState 是 否 String 实例的状态（running 运行中，initializing 初始化中，failed 异常）
DrainStatus 是 是 String 实例是否封锁状态
InstanceAdvancedSettings 是 是 InstanceAdvancedSettings 节点配置
CreatedTime 是 否 String 添加时间

SwitchSet

运维配置

被如下接口引用：DescribeLogSwitches

名称 必选 允许NULL 类型 描述
ClusterId 是 否 String 集群ID
Log 是 是 DescribeLogSwitchInfo 日志运维
Event 是 是 DescribeLogSwitchInfo 事件运维
Audit 是 是 DescribeLogSwitchInfo 审计运维

ClusterInstancesVersion

集群中worker节点不同版本节点数统计信息

被如下接口引用：DescribeInstancesVersion

名称 必选 允许NULL 类型 描述
ClusterId 是 否 String 集群ID
ClusterVersion 是 否 String 集群版本
InstanceVersions 是 否 Array of ClusterInstancesVersionItem 节点版本统计信息
Error 是 是 String 出错信息
UpgradeAble 是 是 Bool 是否存在可升级节点

ChartVersion

ChartVersion

被如下接口引用：

名称 必选 允许NULL 类型 描述
Metadata 否 是 Metadata Metadata
Created 否 是 Datetime_iso 创建时间
Digest 否 是 String Digest
URLs 否 是 Array of String URLs
APIVersion 否 是 String api
AppVersion 否 是 String app
Description 否 是 String Description
Name 否 是 String Name
Version 否 是 String Version
Home 否 是 String home
Icon 否 是 String icon
Keywords 否 是 Array of String keywords
Deprecated 否 是 Bool Deprecated
KubeVersion 否 是 String KubeVersion
Sources 否 是 Array of String Sources

RegionInfo

地域信息

被如下接口引用：

名称 必选 允许NULL 类型 描述
Id 是 否 Uint64 id
Alias 是 否 String gz
RegionName 是 否 String ap-guangzhou
RegionId 是 否 Uint64 1
Remark 是 否 String remark
Status 是 否 String alluser
CreatedAt 是 否 Datetime_iso time
UpdatedAt 是 否 Datetime_iso time

Tag

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

被如下接口引用：CreateCluster、CreateIndependentCluster、CreateTKECluster、DescribeClusters

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

ClusterPublicLB

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

被如下接口引用：

名称 必选 允许NULL 类型 描述
Enabled 是 否 Bool 是否开启公网访问LB
AllowFromCidrs 否 否 Array of String 允许访问的来源CIDR列表

ShieldSettings

告警屏蔽settings，目前仅支持按时间段屏蔽

被如下接口引用：AddAlarmPolicy、DescribeAlarmPolicies、ModifyAlarmPolicy

名称 必选 允许NULL 类型 描述
EnableShield 是 否 Bool 是否启动告警屏蔽功能
ShieldTimeStart 否 是 Int64 告警屏蔽开始时间，单位s，如8:00:00=> 8 * 60 * 60=28800
ShieldTimeEnd 否 是 Int64 告警屏蔽结束时间，单位s，如10:00:00=> 10 * 60 * 60=36000

LogCollector

日志收集信息

被如下接口引用：GetLogCollector、ListLogCollector

名称 必选 允许NULL 类型 描述
Name 否 否 String 日志收集名称
Description 否 否 String 日志收集描述
ClusterId 否 否 String 集群ID
ClusterName 否 否 String 集群名称
CreatedAt 否 否 String 创建时间
InputType 否 否 String 输入类型
OutputType 否 否 String 输出类型
InputOption 否 是 LogInputOption 输入选项
OutputOption 否 是 LogOutputOption 输出选项

NodePoolSet

虚拟节点池信息

被如下接口引用：DescribeClusterVirtualNodePools

名称 必选 允许NULL 类型 描述
NodePoolId 否 否 String 节点池Id
SubnetIds 否 否 Array of String 节点池子网Id
SecurityGroupIds 否 否 Array of String 节点池安全组id
Name 否 否 String 节点池名称
LifeState 否 否 String 节点池状态
Unschedulable 否 否 Bool 不可调度
Labels 否 否 Array of Label 节点池标签
Taints 否 否 Array of Taint 节点池污点

NotReadyPodsItem

集群某个命名空间下NotReady的Pod集合

被如下接口引用：DescribeClusterHealthyStatus

名称 必选 允许NULL 类型 描述
Namespace 是 否 String 命名空间名称
Pods 是 是 Array of String pod列表

SummaryService

Service详细信息

被如下接口引用：DescribeClusterServices

名称 必选 允许NULL 类型 描述
Name 是 是 String Service名称
Status 是 是 String Service状态
ServiceIp 是 是 String Service IP
ExternalIp 是 是 String 外网IP
LbId 是 是 String 负载均衡ID
LbStatus 是 是 String 负载均衡状态
AccessType 是 是 String Service访问类型
DesiredReplicas 是 是 Int64 期望副本数
CurrentReplicas 是 是 Int64 当前副本数
CreatedAt 是 是 String 创建时间
Namespace 是 是 String 命名空间
ReasonMap 是 是 String ReasonMap
SourceReasonMap 是 是 String SourceReasonMap
Labels 是 是 String Labels
SysLables 是 是 String SysLables
UserLables 是 是 String UserLables
ScaleType 是 是 String ScaleType
HpaPolicy 是 是 String HpaPolicy

ZoneInfo

zone信息

被如下接口引用：

名称 必选 允许NULL 类型 描述
Id 是 否 Uint64 ID
Alias 是 否 String alias
RegionName 是 否 String 形如ap-guangzhou
ZoneName 是 否 String 形如ap-guangzhou-2
Status 是 否 String status
Remark 是 否 String Remark
CreatedAt 是 否 Datetime_iso time
UpdatedAt 是 否 Datetime_iso time

ClusterCommon

集群中基础信息

被如下接口引用：

名称 必选 允许NULL 类型 描述
ClusterId 是 否 String 集群ID
ClusterName 是 否 String 集群名称
Description 是 否 String 集群描述
Status 是 否 String 集群状态
ClusterCIDR 是 否 String 集群CIDR
CreatedAt 是 否 String 集群创建时间
NodeNum 是 否 Int64 集群中节点数
MasterNum 是 否 Int64 集群中master节点数量
Os 是 否 Array of String 操作系统名称
K8sVersion 是 否 String K8S集群版本
ClusterExternalEndpoint 是 否 String 集群访问地址
MaxNodePodNum 是 否 Int64 集群最大支持的Pod数量
MaxClusterServiceNum 是 否 Int64 集群最大支持的服务数量
IPVS 是 否 Int64 ipvs
ClusterType 是 否 String 集群类型

EnvironmentVariable

EnvironmentVariable

被如下接口引用：

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

EdgeCluster

边缘计算集群信息

被如下接口引用：

名称 必选 允许NULL 类型 描述
ClusterId 是 否 String 集群Id
ClusterName 是 否 String 集群名称
VpcId 是 否 String Vpc Id
PodCIDR 是 否 String 集群pod cidr
ServiceCIDR 是 否 String 集群 service cidr
K8SVersion 是 否 String k8s 版本号
Status 否 否 String 集群状态
ClusterDesc 否 否 String 集群描述信息
CreatedTime 否 否 String 集群创建时间

ClusterCredential

接入k8s 的认证信息

被如下接口引用：

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

TKEEdgeClusterResources

边缘集群资源详情

被如下接口引用：

名称 必选 允许NULL 类型 描述
ClusterId 是 否 String 集群id
CPU 是 否 Float 集群cpu总和
Memory 是 否 Float 集群memory总和
NodeCount 是 否 Int64 集群节点数

InstanceBaseSettings

节点的基础信息

被如下接口引用：

名称 必选 允许NULL 类型 描述
InstanceId 是 否 String 节点InstanceId
InstanceName 是 否 String 节点名称
Zone 是 否 String 节点所在Zone信息(string)
WanIp 是 否 String 节点外网IP
LanIp 是 否 Array of String 节点内网IP
Cpu 是 否 Uint64 节点CPU（单位：毫核）
Mem 是 否 String 节点内存(单位： M)
Gpu 是 否 Uint64 节点GPU信息
KernelVersion 是 否 String 节点内核版本
OsImage 是 否 String 节点操作系统镜像
IsNormal 是 否 Uint64 节点是否正常标识(0 异常 1 正常 2 创建中)
AbnormalReason 是 否 String 异常原因
K8sVersion 是 否 String K8s版本
NodeRole 是 否 String 节点角色, MASTER, WORKER, ETCD, MASTER_ETCD,ALL, 默认为WORKER
LabelValues 是 否 Array of Label 节点Label标签列表
Unschedulable 是 否 Uint64 是否不可以被调度（0 表示可以被调度， 大于0 表示不可以被调度）

PersistentVolumeClaimVolume

PersistentVolumeClaimVolume

被如下接口引用：

名称 必选 允许NULL 类型 描述
Name 否 否 String pvc名称
DiskId 否 否 String cbs id
FsType 否 否 String fs 类型
ReadOnly 否 否 Bool 是否只读

SecurityPolicy

公网安全策略

被如下接口引用：

名称 必选 允许NULL 类型 描述
Policy 是 否 String 安全策略如192.168.0.0/24
Description 是 否 String 备注

LogInputOptNamespace

日志输入命名空间描述

被如下接口引用：CreateLogCollector、GetLogCollector、ListLogCollector、UpdateLogCollector

名称 必选 允许NULL 类型 描述
Namespace 是 否 String 命名空间
AllContainers 否 否 Bool 是否为命名空间内的所有容器
Services 否 否 Array of String Services名称数组

ResourceStatus

资源状态

被如下接口引用：DescribeClustersResourceStatus

名称 必选 允许NULL 类型 描述
ClusterInstanceId 是 否 String 集群ID
Status 是 否 Array of ResourceStatusItem 各资源状态

ClusterResource

ClusterResource

被如下接口引用：

名称 必选 允许NULL 类型 描述
ClusterId 是 否 String 集群ID
SubnetResources 是 否 Array of SubnetResource 子网资源列表
ClusterPodQuota 否 否 Int64 集群内Pod数量配额
ClusterPodNum 否 否 Int64 集群内已创建的Pod总数量

RouteInfo

集群路由对象

被如下接口引用：DescribeClusterRoutes

名称 必选 允许NULL 类型 描述
RouteTableName 是 否 String 路由表名称。
DestinationCidrBlock 是 否 String 目的端CIDR。
GatewayIp 是 否 String 下一跳地址。

ClusterInspectionProgress

集群巡检当前进度

被如下接口引用：DescribeClusterInspections

名称 必选 允许NULL 类型 描述
Step 是 否 String 当前步骤名称：init_env: 初始化环境，安装agent。init_k8s_resources：获取kubernetes资源init_components: 获取核心组件参数init_machines：获取节点系统参数diagnostic： 正在检查集群
Percent 是 否 Float 检查进度百分比

Filter

过滤器

被如下接口引用：CheckInstancesUpgradeAble、DescribeClusterInstances、DescribeClusters、DescribeExistedInstances

名称 必选 允许NULL 类型 描述
Name 是 否 String 属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。当前只支持按照单个条件ClusterName进行过滤
Values 是 否 Array of String 属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。

ImageInstance

镜像信息

被如下接口引用：DescribeImages

名称 必选 允许NULL 类型 描述
Alias 是 是 String 镜像别名
OsName 是 是 String 操作系统名称
ImageId 是 是 String 镜像ID
OsCustomizeType 是 是 String 容器的镜像版本，"DOCKER_CUSTOMIZE"(容器定制版),"GENERAL"(普通版本，默认值)
Arch 是 是 String 镜像的cpu架构，取值: x86/arm
SportIpv6 否 是 String SportIpv6

NodePoolOption

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

被如下接口引用：AddExistedInstances

名称 必选 允许NULL 类型 描述
AddToNodePool 否 否 Bool 是否加入节点池
NodePoolId 否 否 String 节点池id

AbnormalDetail

异常的资源详情

被如下接口引用：DescribeClustersResourceStatus

名称 必选 允许NULL 类型 描述
Namespace 是 否 String kubernetes namespace
ResourceName 是 否 String kubernetes资源名称

TagSpecification

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

被如下接口引用：CreateCluster、CreateIndependentCluster、CreateTKECluster、DescribeClusters

名称 必选 允许NULL 类型 描述
ResourceType 否 是 String 标签绑定的资源类型，当前支持类型："cluster"
Tags 否 是 Array of Tag 标签对列表

ZoneResourceInfo

可用区资源信息

被如下接口引用：

名称 必选 允许NULL 类型 描述
Zone 否 否 String 可用区，如ap-guangzhou-2
ResourceInfo 否 否 String 资源信息

Node

虚拟节点

被如下接口引用：DescribeClusterVirtualNode

名称 必选 允许NULL 类型 描述
Name 否 否 String 虚拟节点名
NodePoolId 否 否 String 节点池id
SubnetId 否 否 String 节点子网id
Phase 否 否 String 节点状态
CreatedTime 否 否 Datetime 创建时间

PodInfo

Pod的详细描述信息

被如下接口引用：DescribeClusterPods

名称 必选 允许NULL 类型 描述
Name 是 是 String Pod名称
Status 是 是 String Pod当前状态
Reason 是 是 String 处于当前状态原因
SourceReason 是 是 String 在kubernetes中展示的原因
Ip 是 是 String Pod IP
RestartCount 是 是 Int64 Pod重启次数
ReadyCount 是 是 Int64 Pod就绪容器数量
NodeName 是 是 String 所在节点名称
NodeIp 是 是 String 所在节点IP
StartTime 是 是 String Pod启动时间
Containers 是 是 Array of ContainerStatus Pod所含容器信息

IPAddress

IP 地址

被如下接口引用：

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

AutoScalingGroupRange

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

被如下接口引用：ModifyClusterAsGroupAttribute

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

MachineCore

平台machine资源核数

被如下接口引用：CollectAllCore

名称 必选 允许NULL 类型 描述
ProductId 是 否 String 请求id
ProductIdDescribe 否 是 String 产品描述
UsageUnit 是 否 String 使用单元
UsageValue 是 否 String 使用量

ClusterAsGroup

集群关联的伸缩组信息

被如下接口引用：DescribeClusterAsGroups

名称 必选 允许NULL 类型 描述
AutoScalingGroupId 是 否 String 伸缩组ID
Status 是 否 String 伸缩组状态(开启 enabled 开启中 enabling 关闭 disabled 关闭中 disabling 更新中 updating 删除中 deleting 开启缩容中 scaleDownEnabling 关闭缩容中 scaleDownDisabling)
IsUnschedulable 是 是 Bool 节点是否设置成不可调度
Labels 是 是 Array of Label 伸缩组的label列表
CreatedTime 是 是 Datetime 创建时间

UpgradeNodeResetParam

节点升级重装参数

被如下接口引用：UpgradeClusterInstances

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

ScaleMetrics

HPA缩容指标

被如下接口引用：

名称 必选 允许NULL 类型 描述
Name 是 否 String 指标名
Value 是 否 String 指标值

InstanceUpgradeClusterStatus

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

被如下接口引用：GetUpgradeInstanceProgress

名称 必选 允许NULL 类型 描述
PodTotal 是 否 Int64 pod总数
NotReadyPod 是 否 Int64 NotReady pod总数

KeyValueData

KeyValueData

被如下接口引用：

名称 必选 允许NULL 类型 描述
Key 是 否 String key
Value 是 否 String value

ContainerProbeResult

容器探针检查结果

被如下接口引用：

名称 必选 允许NULL 类型 描述
ProbeType 是 否 String 探针类型可用的取值为 liveness 或者 readiness
Ready 是 是 Bool 探针检查结果。在未配置probe规则时为true，在配置规则但是由于通讯问题没有值时为空指针。
TTL 是 否 Uint64 一个检查结果的有效秒数。一般设置成PeriodSeconds的5倍，由客户端每次set时刷新

ClusterAdvancedSettings

集群高级配置

被如下接口引用：CreateCluster、CreateIndependentCluster、CreateTKECluster

名称 必选 允许NULL 类型 描述
IPVS 否 否 Bool 是否启用IPVS
AsEnabled 否 否 Bool 是否启用集群节点自动扩缩容(创建集群流程不支持开启此功能)
ContainerRuntime 否 否 String 集群使用的runtime类型，包括"docker"和"containerd"两种类型，默认为"docker"
NodeNameType 否 否 String 集群中节点NodeName类型（包括 hostname,lan-ip两种形式，默认为lan-ip。如果开启了hostname模式，创建节点时需要设置HostName参数，并且InstanceName需要和HostName一致）
ExtraArgs 否 否 ClusterExtraArgs 集群自定义参数
NetworkType 否 否 String 集群网络类型（包括GR(全局路由)和VPC-CNI两种模式，默认为GR。
IsNonStaticIpMode 否 否 Bool 集群VPC-CNI模式是否为非固定IP，默认: FALSE 固定IP。
IsDualStack 否 否 String 集群是否支持双栈

Taint

kubernetes Taint

被如下接口引用：CreateClusterVirtualNodePool、DescribeClusterVirtualNodePools、ModifyClusterVirtualNodePool

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

EdgeClusterPublicLB

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

被如下接口引用：

名称 必选 允许NULL 类型 描述
Enabled 是 否 Bool 是否开启公网访问LB
AllowFromCidrs 否 否 Array of String 允许访问的公网cidr

RunSecurityServiceEnabled

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

被如下接口引用：AddExistedInstances、UpgradeClusterInstances

名称 必选 允许NULL 类型 描述
Enabled 否 否 Bool 是否开启云安全服务。取值范围：<br><li>TRUE：表示开启云安全服务<br><li>FALSE：表示不开启云安全服务<br><br>默认取值：TRUE。

Volume

Volume

被如下接口引用：

名称 必选 允许NULL 类型 描述
Name 否 否 String 名称
Pvc 否 否 PersistentVolumeClaimVolume pvc volume信息
TencentCbs 否 否 TencentCbsVolume cbs 信息
Secret 否 否 SecretVolume secret
ConfigMapPayload 否 否 Array of PayLoad Config Map Volume payload

Evaluator

告警指标判断逻辑结构体

被如下接口引用：AddAlarmPolicy、DescribeAlarmPolicies、ModifyAlarmPolicy

名称 必选 允许NULL 类型 描述
Type 是 否 String 告警判断类型，目前支持gt和lt两种
Value 是 否 Float 告警设置的阈值

InstanceDataDiskMountSetting

CVM实例数据盘挂载配置

被如下接口引用：CreateCluster

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

EdgeClusterInternalLB

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

被如下接口引用：

名称 必选 允许NULL 类型 描述
Enabled 是 否 Bool 是否开启内网访问LB
SubnetId 否 否 Array of String 内网访问LB关联的子网Id

ExistedInstancesForNode

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

被如下接口引用：CreateCluster

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

Metadata

Metadata

被如下接口引用：DescribeHelmChartDetail

名称 必选 允许NULL 类型 描述
APIVersion 否 是 String api版本
AppVersion 否 是 String app版本
Description 否 是 String 描述
Name 否 是 String 名称
Version 否 是 String 版本

AlarmPolicySettings

告警策略settings

被如下接口引用：AddAlarmPolicy、DescribeAlarmPolicies、ModifyAlarmPolicy

名称 必选 允许NULL 类型 描述
AlarmPolicyName 是 否 String 告警策略名称
AlarmPolicyDescription 否 是 String 告警策略描述
AlarmPolicyType 是 否 String 告警类型，有cluster，node，pod三种类型。
AlarmObjectsType 否 是 String 告警对象绑定类型。all：全部对象绑定。part：只有选择的部分对象绑定。
AlarmMetrics 是 否 Array of AlarmMetric 告警指标列表。
AlarmObjects 是 是 String 告警对象，多个用逗号分隔。

ClusterCondition

集群创建过程

被如下接口引用：

名称 必选 允许NULL 类型 描述
Type 是 否 String 集群创建过程类型
Status 是 否 String 集群创建过程状态
LastProbeTime 是 是 Datetime 最后一次探测到该状态的时间
LastTransitionTime 是 是 Datetime 最后一次转换到该过程的时间
Reason 是 是 String 转换到该过程的简明原因
Message 是 是 String 转换到该过程的更多信息

EksCluster

弹性集群信息

被如下接口引用：

名称 必选 允许NULL 类型 描述
ClusterId 是 否 String 集群Id
ClusterName 是 否 String 集群名称
VpcId 是 否 String Vpc Id
SubnetIds 是 否 Array of String 子网列表
K8SVersion 是 否 String k8s 版本号
Status 否 否 String 集群状态
ClusterDesc 否 否 String 集群描述信息
CreatedTime 否 否 String 集群创建时间
ServiceSubnetId 否 否 String Service 子网Id

LogSet

日志集

被如下接口引用：DescribeClsLogSets

名称 必选 允许NULL 类型 描述
LogSetId 是 否 String 日志集ID
LogSetName 是 否 Array of String 日志集名称
Period 是 否 Int64 周期
CreateTime 是 否 String 创建时间

ClusterAlarmSetting

集群告警设置

被如下接口引用：

名称 必选 允许NULL 类型 描述
ClusterId 是 否 String 集群Id
BMonitor 是 否 Bool 是否设置了监控告警

ExistedInstancesPara

已存在实例的重装参数

被如下接口引用：CreateCluster

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

AvailableExtraArgs

集群可用的自定义参数

被如下接口引用：DescribeClusterAvailableExtraArgs

名称 必选 允许NULL 类型 描述
KubeAPIServer 是 是 Array of Flag kube-apiserver可用的自定义参数
KubeControllerManager 是 是 Array of Flag kube-controller-manager可用的自定义参数
KubeScheduler 是 是 Array of Flag kube-scheduler可用的自定义参数
Kubelet 是 是 Array of Flag kubelet可用的自定义参数

ClusterInfo

集群信息简单描述

被如下接口引用：DescribeUserClusters

名称 必选 允许NULL 类型 描述
ClusterDescription 是 否 String 集群描述
ClusterId 是 否 String 集群ID
ClusterName 是 否 String 集群名称
ClusterType 是 否 String 集群类型
ClusterVersion 是 否 String 集群版本
CreatedTime 是 否 String 集群创建时间

ClusterBasicSettings

描述集群的基本配置信息

被如下接口引用：CreateCluster、CreateIndependentCluster、CreateTKECluster

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

EKSPodInfo

EKSPodInfo

被如下接口引用：

名称 必选 允许NULL 类型 描述
EKSId 是 否 String EKSId
ClusterId 是 否 String 集群ID
Name 是 否 String pod名称
Namespace 是 否 String pod的namespace
Kind 是 否 String 工作负载类型
KindName 是 否 String 工作负载名称
Zone 是 否 String 可用区
VpcId 是 否 String vpcId
SubnetId 是 否 String 子网Id
CPU 是 否 Float cpu
Memory 是 否 Float 内存