数据结构

最近更新时间: 2025-03-12 16:34:39

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 记录时间
示例值:

PersistentVolumeClaimVolume

PersistentVolumeClaimVolume

被如下接口引用:

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

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
示例值:

ChargeInfo

Pod计费信息

被如下接口引用:

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

ContainerStatus

容器状态描述信息

被如下接口引用:

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

RunClusterInspectionResponseItem

触发集群巡检请求返回

被如下接口引用:RunClusterInspections

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

EnvironmentVariable

EnvironmentVariable

被如下接口引用:

名称 必选 允许NULL 类型 描述
Name String key
示例值:
Value String val
示例值:

HostNameValue

节点主机名称结构

被如下接口引用:

名称 必选 允许NULL 类型 描述
Name String 主机名称
示例值:
Value Uint64 主机数量
示例值:

NotifySettings

告警通知settings

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

名称 必选 允许NULL 类型 描述
ReceiverGroups Array of Int64 告警接收组(用户组)
示例值:
NotifyWay Array of String 告警通知方式。SMS表示短信,EMAIL表示邮件,CALL表示电话,WECHAT表示微信
示例值: SMS
PhoneNotifyOrder Array of Int64 电话告警顺序。
注:NotifyWay选择CALL,采用该参数。
示例值:
PhoneCircleTimes Int64 电话告警次数。
注:NotifyWay选择CALL,采用该参数。
示例值:
PhoneInnerInterval Int64 电话告警轮内间隔。单位:秒
注:NotifyWay选择CALL,采用该参数。
示例值:
PhoneCircleInterval Int64 电话告警轮外间隔。单位:秒
注:NotifyWay选择CALL,采用该参数。
示例值:
PhoneArriveNotice Int64 电话告警触达通知
注:NotifyWay选择CALL,采用该参数。
示例值:

UpgradeNodeResetParam

节点升级重装参数

被如下接口引用:UpgradeClusterInstances

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

InstanceAdvancedSettings

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

被如下接口引用:AddExistedInstances、CreateCluster、CreateClusterAsGroup、CreateClusterInstances、DescribeClusterInstances、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加入调度.
示例值: 0
Labels Array of Label 节点Label数组
示例值:查看
DataDisks Array of DataDisk 数据盘相关信息
示例值:查看
ExtraArgs InstanceExtraArgs 节点相关的自定义参数信息
示例值:查看
PreStartUserScript String base64 编码的用户脚本, 此脚本会在 k8s 组件运行前执行, 需要用户保证脚本的可重入及重试逻辑, 脚本及其生成的日志文件可在节点的 /data/ccs_userscript/ 路径查看.
示例值:

TKEEdgeClusterResources

边缘集群资源详情

被如下接口引用:

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

EdgeClusterPublicLB

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

被如下接口引用:

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

ImageInstance

镜像信息

被如下接口引用:DescribeImages

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

RouteTableInfo

集群路由表对象

被如下接口引用:

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

DeletePolicyInfo

删除策略结构体

被如下接口引用:

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

fileEntry

chart返回值

被如下接口引用:DescribeHelmChartDetail

名称 必选 允许NULL 类型 描述
Name String 名称
示例值:
Value String chart值
示例值:
ID Int64 id
示例值:
Children Array of FileEntry fileEntry
示例值:查看

ClusterBasicSettings

描述集群的基本配置信息

被如下接口引用:CreateCluster

名称 必选 允许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"(普通版本,默认值)
示例值: GENERAL
NeedWorkSecurityGroup Bool 是否开启节点的默认安全组(默认: 否)
示例值: false
AutoUpgradeClusterLevel AutoUpgradeClusterLevel 集群自动变配
示例值:查看
ClusterLevel String 托管集群的集群等级
示例值:

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 集群网络对应子网
示例值:

TagSpecification

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

被如下接口引用:CreateCluster、DescribeClusters

名称 必选 允许NULL 类型 描述
ResourceType String 标签绑定的资源类型,当前支持类型:"cluster"
示例值:
Tags Array of Tag 标签对列表
示例值:查看

AddExistInstancesParam

添加已有节点

被如下接口引用:

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

Volume

Volume

被如下接口引用:

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

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
示例值:

NodePoolSet

虚拟节点池信息

被如下接口引用:DescribeClusterVirtualNodePools

名称 必选 允许NULL 类型 描述
NodePoolId String 节点池Id
示例值:
SubnetIds Array of String 节点池子网Id
示例值:
SecurityGroupIds Array of String 节点池安全组id
示例值:
Name String 节点池名称
示例值:
LifeState String 节点池状态。creating表示节点池创建中,appending表示节点池正追加新节点,normal表示节点池正常状态,updating表示节点池更新中,deleting表示节点池删除中,shrinking表示节点池缩容
示例值: creating
Unschedulable Bool 节点池中的超级节点是否不可调度。true表示不可调度,false表示可调度
示例值: true
Labels Array of Label 节点池标签
示例值:查看
Taints Array of Taint 节点池污点
示例值:查看

InstanceUpgradeProgressItem

某个节点的升级进度

被如下接口引用:

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

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 抵扣资源所属产品
示例值:

AutoUpgradeClusterLevel

集群等级自动升级

被如下接口引用:CreateCluster、ModifyClusterAttribute

名称 必选 允许NULL 类型 描述
IsAutoUpgrade Bool 是否开启自动升级。true表示开启自动升级,false表示不开启自动升级
示例值: true

ClusterAlarmSetting

集群告警设置

被如下接口引用:

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

TKEEdgeNodeResources

边缘集群节点资源详情

被如下接口引用:

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

ClusterCredential

接入k8s 的认证信息

被如下接口引用:

名称 必选 允许NULL 类型 描述
CACert String CA 根证书
示例值:
Token String 认证用的Token
示例值:

DescribeLogSwitchInfo

DescribeLogSwitchInfo

被如下接口引用:DescribeLogSwitches

名称 必选 允许NULL 类型 描述
Enable Bool 是否开启。 true:开启,false:未开启
示例值: true
LogsetId String 日志集ID
示例值:
TopicId String 日志主题ID
示例值:

InstanceUpgradePreCheckResultItem

节点升级检查项结果

被如下接口引用:

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

前台Banner展示

被如下接口引用:

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

Result

Result

被如下接口引用:DescribeHelmChartVersion

名称 必选 允许NULL 类型 描述
Chart String chart
示例值:
Name String 名称
示例值:
Score Int64 分数
示例值:

ExistedInstancesForNode

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

被如下接口引用:CreateCluster

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

ClusterLevelAttribute

集群等级属性

被如下接口引用:DescribeClusterLevelAttribute

名称 必选 允许NULL 类型 描述
Name String 名字
示例值:
Alias String Alias
示例值:
NodeCount Uint64 节点数量
示例值:
PodCount Uint64 pod数量
示例值:
ConfigMapCount Uint64 ConfigMap数量
示例值:
RSCount Uint64 RS数量
示例值:
CRDCount Uint64 CRD数量
示例值:
OtherCount Uint64 其他数量
示例值:
Enable Bool 是否启用
示例值:

Metadata

Metadata

被如下接口引用:DescribeHelmChartDetail

名称 必选 允许NULL 类型 描述
APIVersion String api版本
示例值:
AppVersion String app版本
示例值:
Description String 描述
示例值:
Name String 名称
示例值:
Version String 版本
示例值:

Taint

kubernetes Taint

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

名称 必选 允许NULL 类型 描述
Key String Key
示例值:
Value String Value
示例值:
Effect String Effect
示例值:

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
示例值:

MachineCore

平台machine资源核数

被如下接口引用:CollectAllCore

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

LoginSettings

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

被如下接口引用:AddExistedInstances、UpgradeClusterInstances

名称 必选 允许NULL 类型 描述
Password String 实例登录密码。不同操作系统类型密码复杂度限制不一样,具体如下:
  • Linux实例密码必须8到16位,至少包括两项[a-z,A-Z]、[0-9] 和 [( ) ` ~ ! @ # $ % ^ & * - + = 
  • KeyIds Array of String 密钥ID列表。关联密钥后,就可以通过对应的私钥来访问实例;KeyId可通过接口DescribeKeyPairs获取,密钥与密码不能同时指定,同时Windows操作系统不支持指定密钥。当前仅支持购买的时候指定一个密钥。
    示例值:
    KeepImageLogin String 保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为TRUE。取值范围:
  • TRUE:表示保持镜像的登录设置
  • FALSE:表示不保持镜像的登录设置

    默认取值:FALSE。
    示例值:
  • ClusterInstancesVersion

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

    被如下接口引用:DescribeInstancesVersion

    名称 必选 允许NULL 类型 描述
    ClusterId String 集群ID
    示例值:
    ClusterVersion String 集群版本
    示例值:
    InstanceVersions Array of ClusterInstancesVersionItem 节点版本统计信息
    示例值:查看
    Error String 出错信息
    示例值:
    UpgradeAble Bool 是否存在可升级节点。true表示存在,false表示不存在
    示例值: true

    InspectionStatistic

    InspectionStatistic

    被如下接口引用:DescribeClusterInspectionOverviews、DescribeClusterInspections

    名称 必选 允许NULL 类型 描述
    GoodItem Uint64 GoodItem
    示例值:
    WarnItem Uint64 WarnItem
    示例值:
    RiskItem Uint64 RiskItem
    示例值:
    SeriousItem Uint64 SeriousItem
    示例值:
    FailedItem Uint64 FailedItem
    示例值:

    LogSet

    日志集

    被如下接口引用:

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

    CcnInstance

    云联网实例

    被如下接口引用:

    名称 必选 允许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(根账号)
    示例值:

    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 集群类型
    示例值:

    File

    文件

    被如下接口引用:DescribeHelmChartDetail

    名称 必选 允许NULL 类型 描述
    Data String 数据
    示例值:
    Name String 名称
    示例值:

    ServiceAccountVolume

    ServiceAccountVolume

    被如下接口引用:

    名称 必选 允许NULL 类型 描述
    Data Array of KeyValueData data
    示例值:查看

    Evaluator

    告警指标判断逻辑结构体

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

    名称 必选 允许NULL 类型 描述
    Type String 告警判断类型,gt表示大于等于,lt表示小于等于
    示例值: gt
    Value Float 告警设置的阈值
    示例值:

    ClusterCIDRSettings

    集群容器网络相关参数

    被如下接口引用:CreateCluster

    名称 必选 允许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 冲突错误, true表示忽略,false表示不忽略
    示例值: true
    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)
    示例值:

    ContainerEnvs

    ContainerEnvs

    被如下接口引用:

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

    RouteTableConflict

    路由表冲突对象

    被如下接口引用:

    名称 必选 允许NULL 类型 描述
    RouteTableType String 路由表类型。
    示例值:
    RouteTableCidrBlock String 路由表CIDR。
    示例值:
    RouteTableName String 路由表名称。
    示例值:
    RouteTableId String 路由表ID。
    示例值:

    CcnRoute

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

    被如下接口引用:

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

    ImageRegistryCredential

    ImageRegistryCredential

    被如下接口引用:

    名称 必选 允许NULL 类型 描述
    Server String 地址
    示例值:
    Username String user
    示例值:
    Password String pass
    示例值:

    AlarmPolicyFilter

    告警策略过滤

    被如下接口引用:DescribeAlarmPolicies

    名称 必选 允许NULL 类型 描述
    AlarmPolicyName String 告警策略名称
    示例值:

    LogTopic

    日志主题

    被如下接口引用:

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

    RunInstancesForNode

    不同角色的节点配置参数

    被如下接口引用:CreateCluster

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

    AutoScalingGroupRange

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

    被如下接口引用:ModifyClusterAsGroupAttribute

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

    LogInputOption

    日志输入描述

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

    名称 必选 允许NULL 类型 描述
    Path String 路径
    示例值:
    Labels Label 标签 类型为map 键值对
    示例值:查看
    AllNamespaces Bool 是否是全部命名空间。传true表示所有的命名空间,传false表示不是所有的命名空间
    示例值: true
    Namespaces LogInputOptNamespace 命名空间
    示例值:查看

    TaskStepInfo

    任务步骤信息

    被如下接口引用:DescribeUpgradeClusterProgress

    名称 必选 允许NULL 类型 描述
    Step String 升级步骤名称。preUpgrade表示升级前,upgradeMaster表示升级master操作,postUpgrade表示升级后,upgradeNode表示升级node
    示例值: preUpgrade
    LifeState String 任务当前的状态。processing表示任务正在处理中,waiting表示正等待任务执行,done表示任务已经处理完成,unKnow表示任务异常状态
    示例值: processing
    StartAt String 步骤开始时间
    示例值:
    EndAt String 步骤结束时间
    示例值:
    FailedMsg String 若步骤生命周期为failed,则此字段显示错误信息
    示例值:
    InstanceID String 实例ID(仅节点升级使用)
    示例值:

    UpgradeAbleInstancesItem

    可升级节点信息

    被如下接口引用:CheckInstancesUpgradeAble

    名称 必选 允许NULL 类型 描述
    InstanceId String 节点Id
    示例值:
    Version String 节点的当前版本
    示例值:

    ClusterInternalLB

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

    被如下接口引用:

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

    DescribeClusterInspectionItem

    描述集群巡检概览信息

    被如下接口引用:DescribeClusterInspections

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

    Instance

    集群的实例信息

    被如下接口引用:DescribeClusterInstances

    名称 必选 允许NULL 类型 描述
    InstanceId String 实例ID
    示例值:
    InstanceRole String 节点角色。 MASTER_ETCD表示master节点信息,WORKER表示work节点信息
    示例值: MASTER_ETCD
    FailedReason String 实例异常(或者处于初始化中)的原因
    示例值:
    InstanceState String 实例的状态。running表示运行中,initializing表示初始化中,failed表示异常
    示例值: running
    DrainStatus String 实例是否封锁状态,true表示封锁状态,false表示非封锁状态
    示例值: true
    InstanceAdvancedSettings InstanceAdvancedSettings 节点配置
    示例值:查看
    CreatedTime String 添加时间
    示例值:

    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
    示例值:

    ClusterInspectionOverview

    集群巡检一次检测的概览

    被如下接口引用:DescribeClusterInspectionOverviews、DescribeClusterInspections

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

    PodInfo

    Pod的详细描述信息

    被如下接口引用:

    名称 必选 允许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所含容器信息
    示例值:查看

    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 表示不可以被调度)
    示例值:

    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
    示例值:

    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可用的自定义参数
    示例值:查看

    K8SVersions

    K8SVersions

    被如下接口引用:

    名称 必选 允许NULL 类型 描述
    Name String 组件名
    示例值:
    Version String 组件版本
    示例值:
    Status String 状态
    示例值:
    Remark String 描述
    示例值:

    PayLoad

    configmap 数据键值对

    被如下接口引用:

    名称 必选 允许NULL 类型 描述
    Data String configmap base64 encoded data
    示例值:
    Key String configmap file user visible path
    示例值:

    Node

    虚拟节点

    被如下接口引用:DescribeClusterVirtualNode

    名称 必选 允许NULL 类型 描述
    Name String 虚拟节点名
    示例值:
    NodePoolId String 节点池id
    示例值:
    SubnetId String 节点子网id
    示例值:
    Phase String 节点状态。Pending表示节点pending,Running表示节点正常运行,Terminating表示节点删除中,Terminated表示节点已删除,Draining表示节点正在驱逐
    示例值: Pending
    CreatedTime Datetime 创建时间
    示例值:

    ClusterExtraArgs

    集群master自定义参数

    被如下接口引用:CreateCluster、UpdateClusterVersion

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

    EdgeClusterInternalLB

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

    被如下接口引用:

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

    ClusterDefinition

    集群环境相关的参数

    被如下接口引用:

    名称 必选 允许NULL 类型 描述
    RegionId Uint64 集群地域信息
    示例值:
    ProjectId Int64 项目ID(已经废弃)
    示例值:
    MasterLBSubnetId String 集群Mater的LB所在的SubnetId
    示例值:

    DataDisk

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

    被如下接口引用:AddExistedInstances、CreateCluster、CreateClusterAsGroup、CreateClusterInstances、DescribeClusterInstances、UpgradeClusterInstances

    名称 必选 允许NULL 类型 描述
    DiskType String 云盘类型。CLOUD_PREMIUM表示高性能云硬盘, CLOUD_BASIC表示普通云硬盘,CLOUD_SSD表示SSD云硬盘
    示例值: CLOUD_SSD
    FileSystem String 云盘格式化的文件系统。ext3表示格式化为ext3,ext4表示格式化为ext4,xfs表示格式化为xfs
    示例值: ext4
    DiskSize Int64 云盘大小(G)
    示例值:
    AutoFormatAndMount Bool 是否自动化格式盘并挂载。true表示云盘会自动进行格式化并且挂载,false表示不会格式化
    示例值: true
    MountTarget String 挂载目录
    示例值:

    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。
    示例值: INDEPENDENT_CLUSTER
    ClusterNetworkSettings ClusterNetworkSettings 集群网络相关参数
    示例值:查看
    ClusterNodeNum Uint64 集群当前node数量
    示例值:
    ProjectId Uint64 集群所属的项目ID
    示例值:
    TagSpecification Array of TagSpecification 标签描述列表。
    示例值:查看
    ClusterStatus String 集群状态 (Running 运行中  Creating 创建中 Abnormal 异常  )
    示例值: Running
    Property String 集群属性(包括集群不同属性的MAP,属性字段包括NodeNameType (lan-ip模式和hostname 模式,默认无lan-ip模式))
    示例值:
    ClusterMaterNodeNum Uint64 集群当前master数量
    示例值:
    ImageId String 集群使用镜像id
    示例值:
    OsCustomizeType String OsCustomizeType
    示例值:
    ContainerRuntime String 集群运行环境docker或container
    示例值: docker
    CreatedTime String 创建时间
    示例值:
    ClusterArch String 创建的集群架构,取值: x86/arm
    示例值: x86
    DirectAccess String pod直通模式
    示例值:
    ClusterOsAlias String 集群操作系统名称
    示例值:
    IsDualStack String 是否为双栈集群
    示例值:
    Ipv6ServiceCidr String Ipv6 Service Cidr
    示例值:
    ClusterLevel String 集群等级,仅支持托管集群
    示例值:

    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一致)
    示例值:

    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 集群创建时间
    示例值:

    ClusterAsGroupOption

    集群弹性伸缩配置

    被如下接口引用:DescribeClusterAsGroupOption、ModifyClusterAsGroupOptionAttribute

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

    Filter

    过滤器

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

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

    LogCollector

    日志收集信息

    被如下接口引用:GetLogCollector、ListLogCollector

    名称 必选 允许NULL 类型 描述
    Name String 日志收集名称
    示例值:
    Description String 日志收集描述
    示例值:
    ClusterId String 集群ID
    示例值:
    ClusterName String 集群名称
    示例值:
    CreatedAt String 创建时间
    示例值:
    InputType String 日志收集规则的输入类型。传container-log表示收集容器的日志,传host-log表示收集机器的日志。
    示例值: container-log
    OutputType String 日志收集规则的输出类型。传ckafka表示日志收集到ckafka,传kafka表示日志收集到kafka,传cls表示日志收集到cls。
    示例值: cls
    InputOption LogInputOption 输入选项
    示例值:查看
    OutputOption LogOutputOption 输出选项
    示例值:查看

    AbnormalDetail

    异常的资源详情

    被如下接口引用:

    名称 必选 允许NULL 类型 描述
    Namespace String kubernetes namespace
    示例值:
    ResourceName String kubernetes资源名称
    示例值:

    ImageAttributeSet

    unImgId到deviceImageId的映射的数组

    被如下接口引用:

    名称 必选 允许NULL 类型 描述
    ImageId String 镜像id
    示例值:
    InnerImageId Uint64 内部镜像id
    示例值:

    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 过期时间
    示例值:

    ClusterResource

    ClusterResource

    被如下接口引用:

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

    ResourceStatusItem

    资源状态

    被如下接口引用:

    名称 必选 允许NULL 类型 描述
    Dimension String 维度
    示例值:
    TotalNum Uint64 总数
    示例值:
    AbnormalNum Uint64 异常数
    示例值:
    AbnormalDetail Array of AbnormalDetail 异常详情
    示例值:查看

    ShieldSettings

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

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

    名称 必选 允许NULL 类型 描述
    EnableShield Bool 是否启动告警屏蔽功能。true表示启动告警屏蔽,false表示不启用告警屏蔽
    示例值: true
    ShieldTimeStart Int64 告警屏蔽开始时间,单位s,如8:00:00=> 8  60  60=28800
    示例值:
    ShieldTimeEnd Int64 告警屏蔽结束时间,单位s,如10:00:00=> 10  60  60=36000
    示例值:

    ZoneResourceInfo

    可用区资源信息

    被如下接口引用:

    名称 必选 允许NULL 类型 描述
    Zone String 可用区,如ap-guangzhou-2
    示例值:
    ResourceInfo String 资源信息
    示例值:

    ClusterHealthyPodsStatus

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

    被如下接口引用:DescribeClusterHealthyStatus

    名称 必选 允许NULL 类型 描述
    Total Int64 pod总数
    示例值:
    NotReadyTotal Int64 NotReady的pod总数
    示例值:
    NotReadyPods Array of NotReadyPodsItem NotReady的pod详细信息
    示例值:查看

    InstanceDataDiskMountSetting

    CVM实例数据盘挂载配置

    被如下接口引用:CreateCluster

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

    ClusterInfo

    集群信息简单描述

    被如下接口引用:

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

    VersionInstance

    版本信息

    被如下接口引用:DescribeVersions

    名称 必选 允许NULL 类型 描述
    Name String 版本名称
    示例值:
    Version String 版本信息
    示例值:
    Remark String Remark
    示例值:

    NotReadyPodsItem

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

    被如下接口引用:DescribeClusterHealthyStatus

    名称 必选 允许NULL 类型 描述
    Namespace String 命名空间名称
    示例值:
    Pods Array of String pod列表
    示例值:

    Tag

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

    被如下接口引用:CreateCluster、DescribeClusters

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

    ClusterInspectionProgress

    集群巡检当前进度

    被如下接口引用:DescribeClusterInspections

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

    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',该参数为空表示不校验)
    示例值:

    KeyValueData

    KeyValueData

    被如下接口引用:

    名称 必选 允许NULL 类型 描述
    Key String key
    示例值:
    Value String value
    示例值:

    ClusterPublicLB

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

    被如下接口引用:

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

    IPAddress

    IP 地址

    被如下接口引用:

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

    LogInputOptNamespace

    日志输入命名空间描述

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

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

    RunSecurityServiceEnabled

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

    被如下接口引用:AddExistedInstances、UpgradeClusterInstances

    名称 必选 允许NULL 类型 描述
    Enabled Bool 是否开启云安全服务。 true表示开启云安全服务,false表示不开启云安全服务
    示例值: true

    InstanceExtraArgs

    节点自定义参数

    被如下接口引用:AddExistedInstances、CreateCluster、CreateClusterAsGroup、CreateClusterInstances、DescribeClusterInstances、UpgradeClusterInstances

    名称 必选 允许NULL 类型 描述
    Kubelet Array of String kubelet自定义参数
    示例值:

    AlarmPolicy

    告警策略结构体

    被如下接口引用:DescribeAlarmPolicies

    名称 必选 允许NULL 类型 描述
    AlarmPolicyId String 告警策略ID
    示例值:
    ClusterInstanceId String k8s集群ID
    示例值:
    Namespace String k8s命名空间
    示例值:
    WorkloadType String k8s工作负载类型。Deployment表示deployment工作负载,DaemonSet表示DaemonSet工作负载,StatefulSet表示StatefulSet工作负载
    示例值: Deployment
    AlarmPolicySettings AlarmPolicySettings 告警策略settings
    示例值:查看
    NotifySettings NotifySettings 告警通知settings
    示例值:查看
    ShieldSettings ShieldSettings 告警屏蔽settings
    示例值:查看

    ClusterInstancesVersionItem

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

    被如下接口引用:DescribeInstancesVersion

    名称 必选 允许NULL 类型 描述
    InstanceVersion String 版本
    示例值:
    Total Uint64 节点数
    示例值:
    UpgradeAble Bool 是否可升级。true表示可升级,false表示不可升级
    示例值: true

    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 内存
    示例值:

    Label

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

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

    名称 必选 允许NULL 类型 描述
    Name String map表中的Name
    示例值:
    Value String map表中的Value
    示例值:

    CertificateInfo

    客户证书信息

    被如下接口引用:ListClusterCertificates

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

    ClusterAsGroupAttribute

    集群伸缩组属性

    被如下接口引用:ModifyClusterAsGroupAttribute

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

    RegionInstance

    地域属性信息

    被如下接口引用:DescribeRegions

    名称 必选 允许NULL 类型 描述
    RegionName String 地域名称
    示例值:
    RegionId Int64 地域ID
    示例值:
    Status String 地域状态。AVAILABLE表示地域可用,UNAVAILABLE表示地域不可用
    示例值: AVAILABLE
    FeatureGates String 地域特性开关(按照JSON的形式返回所有属性)
    示例值:
    Alias String 地域简称
    示例值:
    Remark String 地域白名单
    示例值:

    ResourceStatus

    资源状态

    被如下接口引用:

    名称 必选 允许NULL 类型 描述
    ClusterInstanceId String 集群ID
    示例值:
    Status Array of ResourceStatusItem 各资源状态
    示例值:查看

    Step

    执行步骤信息

    被如下接口引用:DescribeClusterCreateProgress

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

    RouteInfo

    集群路由对象

    被如下接口引用:

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

    AlarmPolicySettings

    告警策略settings

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

    名称 必选 允许NULL 类型 描述
    AlarmPolicyName String 告警策略名称
    示例值:
    AlarmPolicyDescription String 告警策略描述
    示例值:
    AlarmPolicyType String 告警类型,cluster表示集群类型,node表示节点类型,pod表示pod类型
    示例值: cluster
    AlarmObjectsType String 告警对象绑定类型。all表示全部对象绑定。part表示只有选择的部分对象绑定。
    示例值: all
    AlarmMetrics Array of AlarmMetric 告警指标列表。
    示例值:查看
    AlarmObjects String 告警对象,多个用逗号分隔。
    示例值:

    InspectionReportItem

    健康检查结果项目

    被如下接口引用:DescribeClusterInspectionReport

    名称 必选 允许NULL 类型 描述
    Name String 名称
    示例值:
    Error String 错误信息
    示例值:

    SimplePodInfo

    驱逐节点返回值

    被如下接口引用:DrainClusterNode、DrainClusterVirtualNode

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

    ClusterAsGroup

    集群关联的伸缩组信息

    被如下接口引用:DescribeClusterAsGroups

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

    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
    示例值: true
    Unit String 指标单位
    示例值:

    EnhancedService

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

    被如下接口引用:AddExistedInstances、UpgradeClusterInstances

    名称 必选 允许NULL 类型 描述
    SecurityService RunSecurityServiceEnabled 开启云安全服务。若不指定该参数,则默认开启云安全服务。
    示例值:查看
    MonitorService RunMonitorServiceEnabled 开启云安全服务。若不指定该参数,则默认开启云监控服务。
    示例值:查看

    NodePoolOption

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

    被如下接口引用:AddExistedInstances

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

    SecretVolume

    SecretVolume

    被如下接口引用:

    名称 必选 允许NULL 类型 描述
    Data Array of KeyValueData secret
    示例值:查看
    Type String type
    示例值:

    CommonNames

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

    被如下接口引用:DescribeClusterCommonNames

    名称 必选 允许NULL 类型 描述
    CN String 对应commonName
    示例值:
    SubaccountUin String 子账户id
    示例值:

    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
    示例值:

    ExistedInstance

    已经存在的实例信息

    被如下接口引用:DescribeExistedInstances

    名称 必选 允许NULL 类型 描述
    Usable Bool 实例是否支持加入集群(true 可以加入 false 不能加入)
    示例值: true
    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上的实例计费。
    示例值: PREPAID
    CPU Uint64 实例的CPU核数,单位:核。
    示例值:
    Memory Uint64 实例内存容量,单位:GB。
    示例值:
    OsName String 操作系统名称。
    示例值:
    InstanceType String 实例机型。
    示例值:
    IPv6Addresses Array of String ipv6地址
    示例值:

    ScaleMetrics

    HPA缩容指标

    被如下接口引用:

    名称 必选 允许NULL 类型 描述
    Name String 指标名
    示例值:
    Value String 指标值
    示例值:

    LogOutputOption

    日志收集输出选项

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

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

    SubnetResource

    SubnetResource

    被如下接口引用:

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

    InstanceUpgradePreCheckResult

    某个节点升级前检查结果

    被如下接口引用:

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

    RunMonitorServiceEnabled

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

    被如下接口引用:AddExistedInstances、UpgradeClusterInstances

    名称 必选 允许NULL 类型 描述
    Enabled Bool 是否开启云监控服务。 true表示开启云监控服务,false表示不开启云监控服务
    示例值: true

    ZoneResource

    可用区资源

    被如下接口引用:

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

    ClusterCondition

    集群创建过程

    被如下接口引用:

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

    ContainerProbeResult

    容器探针检查结果

    被如下接口引用:

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

    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
    示例值:查看

    SwitchSet

    运维配置

    被如下接口引用:DescribeLogSwitches

    名称 必选 允许NULL 类型 描述
    ClusterId String 集群ID
    示例值:
    Log DescribeLogSwitchInfo 日志运维
    示例值:查看
    Event DescribeLogSwitchInfo 事件运维
    示例值:查看
    Audit DescribeLogSwitchInfo 审计运维
    示例值:查看

    HPAInfo

    HPA信息

    被如下接口引用:

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

    InstanceUpgradeClusterStatus

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

    被如下接口引用:

    名称 必选 允许NULL 类型 描述
    PodTotal Int64 pod总数
    示例值:
    NotReadyPod Int64 NotReady pod总数
    示例值:

    MachineGroup

    机器组

    被如下接口引用:

    名称 必选 允许NULL 类型 描述
    GroupId String 机器组ID
    示例值:
    GroupName String 机器组名称
    示例值:

    TencentCbsVolume

    TencentCbsVolume

    被如下接口引用:

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

    SecurityPolicy

    公网安全策略

    被如下接口引用:

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

    ClusterStatus

    集群状态信息

    被如下接口引用:DescribeClusterStatus

    名称 必选 允许NULL 类型 描述
    ClusterId String 集群Id
    示例值:
    ClusterState String 集群状态。Creating表示集群创建中,Running表示集群正常运行,Upgrading表示集群升级中,Abnormal表示集群异常
    示例值: Creating
    ClusterInstanceState String 集群实例状态。Unknown表示非法状态,Creating表示正在创建中,Upgrading表示实例正在升级中,AllNormal表示所有实例正常,AllAbnormal表示所有实例异常,PartialAbnormal表示部分实例异常
    示例值: AllNormal
    ClusterBMonitor Bool 集群是否开启监控。true表示开启了监控,false表示未开启监控
    示例值: true
    ClusterInitNodeNum Int64 集群创建中的节点数,-1表示获取节点状态超时,-2表示获取节点状态失败
    示例值:
    ClusterRunningNodeNum Int64 集群运行中的节点数,-1表示获取节点状态超时,-2表示获取节点状态失败
    示例值:
    ClusterFailedNodeNum Int64 集群异常的节点数,-1表示获取节点状态超时,-2表示获取节点状态失败
    示例值:
    ClusterClosedNodeNum Int64 集群已关机的节点数,-1表示获取节点状态超时,-2表示获取节点状态失败
    示例值:
    ClusterClosingNodeNum Int64 集群关机中的节点数,-1表示获取节点状态超时,-2表示获取节点状态失败
    示例值:

    ClusterAdvancedSettings

    集群高级配置

    被如下接口引用:CreateCluster

    名称 必选 允许NULL 类型 描述
    IPVS Bool 是否启用IPVS
    示例值: false
    AsEnabled Bool 是否启用集群节点自动扩缩容(创建集群流程不支持开启此功能)
    示例值: 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 Bool 集群VPC-CNI模式是否为非固定IP,默认: FALSE 固定IP。
    示例值: false
    IsDualStack String 集群是否支持双栈,true表示支持双栈,false表示不支持双栈,默认为false
    示例值: false