Data Types

Last updated: 2021-03-19 16:38:27

AutoScalingGroupRange

Maximum and minimum number of pods in cluster-associated scaling groups

Used by actions: ModifyClusterAsGroupAttribute.

Name Type Required Description
MinSize Integer No Minimum number of pods in a scaling group
MaxSize Integer No Maximum number of pods in a scaling group

AutoscalingAdded

Nodes that are added in scale-out

Used by actions: DescribeClusterNodePoolDetail, DescribeClusterNodePools.

Name Type Description
Joining Integer Number of nodes that are being added
Initializing Integer Number of nodes that are being initialized
Normal Integer Number of normal nodes
Total Integer Total number of nodes

Cluster

Cluster information struct

Used by actions: DescribeClusters.

Name Type Description
ClusterId String Cluster ID
ClusterName String Cluster name
ClusterDescription String Cluster description
ClusterVersion String Cluster version. The default value is 1.10.5.
ClusterOs String Cluster operating system. centOS 7.2x86_64 or ubuntu 16.04.1 LTSx86_64. Default value: ubuntu 16.04.1 LTSx86_64
ClusterType String Cluster type. Managed cluster: MANAGED_CLUSTER; Self-deployed cluster: INDEPENDENT_CLUSTER.
ClusterNetworkSettings ClusterNetworkSettings Cluster network-related parameters
ClusterNodeNum Integer Current number of nodes in the cluster
ProjectId Integer ID of the project to which the cluster belongs
TagSpecification Array of TagSpecification Tag description list.
ClusterStatus String Cluster status (Running, Creating, or Abnormal)
Property String Cluster attributes (including a map of different cluster attributes, with attribute fields including NodeNameType (lan-ip mode and hostname mode, with lan-ip mode as default))
ClusterMaterNodeNum Integer Number of primary nodes currently in the cluster
ImageId String ID of the image used by the cluster
Note: this field may return null, indicating that no valid value is obtained.
OsCustomizeType String Container image tag
Note: This field may return null, indicating that no valid value was found.
ContainerRuntime String Runtime environment of the cluster. Values can be docker or containerd.
Note: this field may return null, indicating that no valid value is obtained.
CreatedTime String Creation time
Note: this field may return null, indicating that no valid value is obtained.
DeletionProtection Boolean Whether Deletion Protection is enabled
Note: this field may return null, indicating that no valid value is obtained.

ClusterAdvancedSettings

Cluster advanced configurations

Used by actions: CreateCluster.

Name Type Required Description
IPVS Boolean No Whether IPVS is enabled
AsEnabled Boolean No Whether auto-scaling is enabled for nodes in the cluster (Enabling this function is not supported when you create a cluster)
ContainerRuntime String No Type of runtime component used by the cluster. The types include "docker" and "containerd". Default value: docker
NodeNameType String No NodeName type for a node in a cluster (This includes the two forms of hostname and lan-ip, with the default as lan-ip. If hostname is used, you need to set the HostName parameter when creating a node, and the InstanceName needs to be the same as the HostName.)
ExtraArgs ClusterExtraArgs No Cluster custom parameter
NetworkType String No Cluster network type, which can be GR (Global Router) or VPC-CNI. The default value is GR.
IsNonStaticIpMode Boolean No Whether a cluster in VPC-CNI mode uses dynamic IP addresses. The default value is FALSE, which indicates that static IP addresses are used.
DeletionProtection Boolean No Indicates whether to enable cluster deletion protection.
KubeProxyMode String No Cluster network proxy model, which is only used when ipvs-bpf mode is used. At present, TKE cluster supports three network proxy modes including iptables, ipvs and ipvs-bpf and their parameter setting relationships are as follows:
iptables: do not set IPVS and KubeProxyMode.
ipvs: set IPVS to true and do not set KubeProxyMode.
ipvs-bpf: set KubeProxyMode to kube-proxy-bpf.
The following conditions are required to use ipvs-bpf network mode:
1. The cluster version must be v1.14 or later.
2. The system image must be Tencent Linux 2.4.
AuditEnabled Boolean No Indicates whether to enable auditing
AuditLogsetId String No Specifies the ID of logset to which the audit logs are uploaded.
AuditLogTopicId String No Specifies the ID of topic to which the audit logs are uploaded.
VpcCniType String No Specifies whether the VPC CNI type is multi-IP ENI or or independent ENI.
RuntimeVersion String No Runtime version
EnableCustomizedPodCIDR Boolean No Indicates whether to enable the custom mode for the node’s pod CIDR range
BasePodNumber Integer No The basic number of Pods in custom mode

ClusterAsGroup

Cluster-associated scaling group information

Used by actions: DescribeClusterAsGroups.

Name Type Description
AutoScalingGroupId String Scaling group ID
Status String Scaling group status (enabled, enabling, disabled, disabling, updating, deleting, scaleDownEnabling, scaleDownDisabling)
IsUnschedulable Boolean Whether the node is set to unschedulable
Note: this field may return null, indicating that no valid value was found.
Labels Array of Label Scaling group label list
Note: this field may return null, indicating that no valid value was found.
CreatedTime String Creation time

ClusterAsGroupAttribute

Cluster scaling group attributes

Used by actions: ModifyClusterAsGroupAttribute.

Name Type Required Description
AutoScalingGroupId String No Scaling group ID
AutoScalingGroupEnabled Boolean No Whether it is enabled
AutoScalingGroupRange AutoScalingGroupRange No Maximum and minimum number of pods in a scaling group

ClusterAsGroupOption

Cluster auto scaling configuration

Used by actions: DescribeClusterAsGroupOption, ModifyClusterAsGroupOptionAttribute.

Name Type Description
IsScaleDownEnabled Boolean Whether to enable scale-in
Note: this field may return null, indicating that no valid value was found.
Expander String The scale-out method when there are multiple scaling groups. random: select a random scaling group. most-pods: choose the scaling group that can schedule the most pods. least-waste: select the scaling group that can ensure the fewest remaining resources after Pod scheduling.. The default value is random.)
Note: this field may return null, indicating that no valid value was found.
MaxEmptyBulkDelete Integer Max concurrent scale-in volume
Note: this field may return null, indicating that no valid value was found.
ScaleDownDelay Integer Number of minutes after cluster scale-out when the system starts judging whether to perform scale-in
Note: this field may return null, indicating that no valid value was found.
ScaleDownUnneededTime Integer Number of consecutive minutes of idleness after which the node is subject to scale-in (default value: 10)
Note: this field may return null, indicating that no valid value was found.
ScaleDownUtilizationThreshold Integer Percentage of node resource usage below which the node is considered to be idle (default value: 50)
Note: this field may return null, indicating that no valid value was found.
SkipNodesWithLocalStorage Boolean During scale-in, ignore nodes with local storage pods (default value: False)
Note: this field may return null, indicating that no valid value was found.
SkipNodesWithSystemPods Boolean During scale-in, ignore nodes with pods in the kube-system namespace that are not managed by DaemonSet (default value: False)
Note: this field may return null, indicating that no valid value was found.
IgnoreDaemonSetsUtilization Boolean Whether to ignore DaemonSet pods by default when calculating resource usage (default value: False: do not ignore)
Note: this field may return null, indicating that no valid value was found.
OkTotalUnreadyCount Integer Number at which CA health detection is triggered (default value: 3). After the number specified in OkTotalUnreadyCount is exceeded, CA will perform health detection.
Note: this field may return null, indicating that no valid value was found.
MaxTotalUnreadyPercentage Integer Max percentage of unready nodes. After the max percentage is exceeded, CA will stop operation.
Note: this field may return null, indicating that no valid value was found.
ScaleDownUnreadyTime Integer Amount of time before unready nodes become eligible for scale-in
Note: this field may return null, indicating that no valid value was found.
UnregisteredNodeRemovalTime Integer Waiting time before CA deletes nodes that are not registered in Kubernetes
Note: this field may return null, indicating that no valid value was found.

ClusterBasicSettings

Describes the basic configuration information of a cluster

Used by actions: CreateCluster.

Name Type Required Description
ClusterOs String No Cluster operating system. CentOS 7.2x86_64 or Ubuntu 16.04.1 LTSx86_64. Default value: Ubuntu 16.04.1 LTSx86_64
ClusterVersion String No Cluster version. The default value is 1.10.5.
ClusterName String No Cluster name
ClusterDescription String No Cluster description
VpcId String No VPC ID, in the format of vpc-xxx, which is required when you create an empty managed cluster.
ProjectId Integer No ID of the project to which the new resources in the cluster belong.
TagSpecification Array of TagSpecification No Tag description list. This parameter is used to bind a tag to a resource instance. Currently, a tag can only be bound to cluster instances.
OsCustomizeType String No Container image tag, DOCKER_CUSTOMIZE (container customized tag), GENERAL (general tag, default value)
NeedWorkSecurityGroup Boolean No Whether to enable the node’s default security group (default: No, Aphla feature)

ClusterCIDRSettings

Container networking parameters for the cluster

Used by actions: CreateCluster.

Name Type Required Description
ClusterCIDR String No CIDR used to assign container and service IPs for the cluster. It cannot conflict with the VPC's CIDR or the CIDRs of other clusters in the same VPC
IgnoreClusterCIDRConflict Boolean No Whether to ignore ClusterCIDR conflict errors, which are not ignored by default
MaxNodePodNum Integer No Maximum number of pods on each node in the cluster
MaxClusterServiceNum Integer No Maximum number of cluster services
ServiceCIDR String No The CIDR block used to assign cluster service IP addresses. It must conflict with neither the VPC CIDR block nor with CIDR blocks of other clusters in the same VPC instance. The IP range must be within the private network IP range, such as 10.1.0.0/14, 192.168.0.1/18, and 172.16.0.0/16.
EniSubnetIds Array of String No Subnet ID of the ENI in VPC-CNI network mode
ClaimExpiredSeconds Integer No Repossession time of ENI IP addresses in VPC-CNI network mode, whose range is [300,15768000)

ClusterExtraArgs

Cluster master custom parameter

Used by actions: CreateCluster.

Name Type Required Description
KubeAPIServer Array of String No kube-apiserver custom parameter, in the format of ["k1=v1", "k1=v2"], for example: ["max-requests-inflight=500","feature-gates=PodShareProcessNamespace=true,DynamicKubeletConfig=true"].
Note: this field may return null, indicating that no valid value is obtained.
KubeControllerManager Array of String No kube-controller-manager custom parameter
Note: this field may return null, indicating that no valid value is obtained.
KubeScheduler Array of String No kube-scheduler custom parameter
Note: this field may return null, indicating that no valid value is obtained.
Etcd Array of String No etcd custom parameter, which is only effective for self-deployed cluster.
Note: this field may return null, indicating that no valid value is obtained.

ClusterNetworkSettings

Cluster network-related parameters

Used by actions: DescribeClusters.

Name Type Required Description
ClusterCIDR String Yes CIDR used to assign container and service IPs for the cluster. It cannot conflict with the VPC's CIDR or the CIDRs of other clusters in the same VPC.
IgnoreClusterCIDRConflict Boolean No Whether to ignore ClusterCIDR conflict errors. It defaults to not ignore.
MaxNodePodNum Integer No Maximum number of pods on each node in the cluster. Default value: 256
MaxClusterServiceNum Integer No Maximum number of cluster services. Default value: 256
Ipvs Boolean No Whether IPVS is enabled. Default value: disabled
VpcId String No Cluster VPC ID, which is required when you create an empty cluster; otherwise, it is automatically set to be consistent with that of the nodes in the cluster
Cni Boolean No Whether CNI is enabled for network plugin(s). Default value: enabled

ClusterVersion

Cluster version information

Used by actions: DescribeAvailableClusterVersion.

Name Type Description
ClusterId String Cluster ID
Versions Array of String The list of cluster major version, such as 1.18.4

DataDisk

Described the configuration and information of k8s node data disk.

Used by actions: AddExistedInstances, CreateCluster, CreateClusterAsGroup, CreateClusterInstances, CreateClusterNodePool, DescribeClusterInstances, UpgradeClusterInstances.

Name Type Description
DiskType String Disk type
Note: this field may return null, indicating that no valid values can be obtained.
FileSystem String File system (ext3/ext4/xfs)
Note: This field may return null, indicating that no valid value was found.
DiskSize Integer Disk size (G)
Note: This field may return null, indicating that no valid value was found.
AutoFormatAndMount Boolean Whether the disk is auto-formatted and mounted
Note: this field may return null, indicating that no valid value is obtained.
MountTarget String Mounting directory
Note: This field may return null, indicating that no valid value was found.

EnhancedService

Describes the configuration of enhanced services, such as Cloud Security and Cloud Monitor.

Used by actions: AddExistedInstances, CreateCluster, UpgradeClusterInstances.

Name Type Required Description
SecurityService RunSecurityServiceEnabled No Enables cloud security service. If this parameter is not specified, the cloud security service will be enabled by default.
MonitorService RunMonitorServiceEnabled No Enables cloud monitor service. If this parameter is not specified, the cloud monitor service will be enabled by default.

ExistedInstance

Information of existing instances

Used by actions: DescribeExistedInstances.

Name Type Description
Usable Boolean Whether the instance supports being added to the cluster (TRUE: support; FALSE: not support).
Note: This field may return null, indicating that no valid values can be obtained.
UnusableReason String Reason that the instance does not support being added.
Note: This field may return null, indicating that no valid values can be obtained.
AlreadyInCluster String ID of the cluster in which the instance currently resides.
Note: This field may return null, indicating that no valid values can be obtained.
InstanceId String Instance ID, in the format of ins-xxxxxxxx.
InstanceName String Instance name.
Note: This field may return null, indicating that no valid values can be obtained.
PrivateIpAddresses Array of String List of private IPs of the instance's primary ENI.
Note: This field may return null, indicating that no valid values can be obtained.
PublicIpAddresses Array of String List of public IPs of the instance's primary ENI.
Note: This field may return null, indicating that no valid values can be obtained.
CreatedTime String Creation time, which follows the ISO8601 standard and uses UTC time. Format: YYYY-MM-DDThh:mm:ssZ.
Note: This field may return null, indicating that no valid values can be obtained.
CPU Integer Instance's number of CPU cores. Unit: cores.
Note: This field may return null, indicating that no valid values can be obtained.
Memory Integer Instance's memory capacity. Unit: GB.
Note: This field may return null, indicating that no valid values can be obtained.
OsName String Operating system name.
Note: This field may return null, indicating that no valid values can be obtained.
InstanceType String Instance model.
Note: This field may return null, indicating that no valid values can be obtained.
AutoscalingGroupId String Auto scaling group ID
Note: This field may return null, indicating that no valid value was found.
InstanceChargeType String Instance billing method. Valid values: POSTPAID_BY_HOUR (pay-as-you-go hourly); CDHPAID (billed based on CDH, i.e., only CDH is billed but not the instances on CDH)
Note: This field may return null, indicating that no valid value was found.

ExistedInstancesForNode

Configuration parameters of existing nodes in differ