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 |
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 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. |
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 |
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 |
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 |
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. |
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) |
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) |
Cluster master custom parameter
Used by actions: CreateCluster, UpdateClusterVersion.
| 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. |
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 |
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 |
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. |
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. |
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. |
Configuration parameters of existing nodes in different roles
Used by actions: CreateCluster.
| Name | Type | Required | Description |
|---|---|---|---|
| NodeRole | String | Yes | Node role. Values: MASTER_ETCD, WORKER. You only need to specify MASTER_ETCD when creating a self-deployed cluster (INDEPENDENT_CLUSTER). |
| ExistedInstancesPara | ExistedInstancesPara | Yes | Reinstallation parameter of existing instances |
| InstanceAdvancedSettingsOverride | InstanceAdvancedSettings | No | Advanced node setting, which overrides the InstanceAdvancedSettings item set at the cluster level (currently valid for the ExtraArgs node custom parameter only) |
Reinstallation parameter of existing instances
Used by actions: CreateCluster.
| Name | Type | Required | Description |
|---|---|---|---|
| InstanceIds | Array of String | Yes | Cluster ID |
| InstanceAdvancedSettings | InstanceAdvancedSettings | No | Additional parameter to be set for the instance |
| EnhancedService | EnhancedService | No | Enhanced services. This parameter is used to specify whether to enable Cloud Security, Cloud Monitor and other services. If this parameter is not specified, Cloud Monitor and Cloud Security are enabled by default. |
| LoginSettings | LoginSettings | No | Node login information (currently only supports using Password or single KeyIds) |
| SecurityGroupIds | Array of String | No | Security group to which the instance belongs. This parameter can be obtained from the sgId field in the returned values of DescribeSecurityGroups. If this parameter is not specified, the default security group is bound. (Currently, you can only set a single sgId) |
| HostName | String | No | When reinstalling the system, you can specify the HostName of the modified instance (when the cluster is in HostName mode, this parameter is required, and the rule name is the same as the Create CVM Instance API HostName except for uppercase letters not being supported. |
Information of the add-on selected for installation during cluster creation
Used by actions: CreateCluster.
| Name | Type | Required | Description |
|---|---|---|---|
| AddonName | String | Yes | Add-on name |
| AddonParam | String | Yes | Add-on information (description of the add-on resource object in JSON string format) |
Key-value pair filters used for conditional queries, such as filtering results by ID, name, and state.
- If there are multiple
Filterparameters, they are evaluated using the logicalANDoperator.- If a
Filtercontains multipleValues, they are evaluated using the logicalORoperator.Take DescribeInstances as an example. You can use the following filters to query the instances in availability zone (
zone) Guangzhou Zone 1 and whose billing plan (instance-charge-type) is pay-as-you-go:
Filters.0.Name=zone
&Filters.0.Values.0=ap-guangzhou-1
&Filters.1.Name=instance-charge-type
&Filters.1.Values.0=POSTPAID_BY_HOUR
Used by actions: CheckInstancesUpgradeAble, DescribeClusterRoutes, DescribeClusters, DescribeExistedInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Filters. |
| Values | Array of String | Yes | Filter values. |
Image details
Used by actions: DescribeImages.
| Name | Type | Description |
|---|---|---|
| Alias | String | Image alias 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. |
| ImageId | String | Image ID Note: this field may return null, indicating that no valid values can be obtained. |
| OsCustomizeType | String | Container image tag, DOCKER_CUSTOMIZE (container customized tag), GENERAL (general tag, default value) Note: this field may return null, indicating that no valid values can be obtained. |
Cluster's instance information
Used by actions: DescribeClusterInstances.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID |
| InstanceRole | String | Node role: MASTER, WORKER, ETCD, MASTER_ETCD, and ALL. Default value: WORKER |
| FailedReason | String | Reason for instance exception (or initialization) |
| InstanceState | String | Instance status (running, initializing, or failed) |
| DrainStatus | String | Whether the instance is drained Note: this field may return null, indicating that no valid value is obtained. |
| InstanceAdvancedSettings | InstanceAdvancedSettings | Node settings Note: this field may return null, indicating that no valid value is obtained. |
| CreatedTime | String | Creation time |
| LanIP | String | Node private IP Note: this field may return null, indicating that no valid values can be obtained. |
| NodePoolId | String | Resource pool ID Note: this field may return null, indicating that no valid values can be obtained. |
| AutoscalingGroupId | String | ID of the auto-scaling group Note: this field may return null, indicating that no valid value is obtained. |
Describes K8s cluster configuration and related information.
Used by actions: AddExistedInstances, CreateCluster, CreateClusterAsGroup, CreateClusterInstances, CreateClusterNodePool, DescribeClusterInstances, UpgradeClusterInstances.
| Name | Type | Description |
|---|---|---|
| MountTarget | String | Data disk mount point. By default, no data disk is mounted. Data disks in ext3, ext4, or XFS file system formats will be mounted directly, while data disks in other file systems and unformatted data disks will automatically be formatted as ext4 (xfs for tlinux system) and then mounted. Please back up your data in advance. This setting is only applicable to CVMs with a single data disk. Note: in multi-disk scenarios, use the DataDisks data structure below to set the corresponding information, such as cloud disk type, cloud disk size, mount path, and whether to perform formatting. Note: this field may return null, indicating that no valid values can be obtained. |
| DockerGraphPath | String | Specified value of dockerd --graph. Default value: /var/lib/docker Note: This field may return null, indicating that no valid value was found. |
| UserScript | String | Base64-encoded user script, which will be executed after the K8s component starts running. You need to ensure the reentrant and retry logic of the script. The script and its log files can be viewed at the node path: /data/ccs_userscript/. If you want to initialize nodes before adding them to the scheduling list, you can use this parameter together with the unschedulable parameter. After the final initialization of userScript is completed, add the kubectl uncordon nodename --kubeconfig=/root/.kube/config command to enable the node for scheduling. Note: This field may return null, indicating that no valid value was found. |
| Unschedulable | Integer | Sets whether the added node is schedulable. 0 (default): schedulable; other values: unschedulable. After node initialization is completed, you can run kubectl uncordon nodename to enable this node for scheduling. |
| Labels | Array of Label | Node label array Note: This field may return null, indicating that no valid value was found. |
| DataDisks | Array of DataDisk | Mounting information of multiple data disks. Ensure that the CVM purchase parameter specifies the information required for the purchase of multiple data disks, for example DataDisks under RunInstancesPara of the CreateClusterInstances API. You can refer to the example of adding a cluster node with multiple data disks in the CreateClusterInstances API. This parameter does not take effect when the AddExistedInstances API is called.Note: this field may return null, indicating that no valid values can be obtained. |
| ExtraArgs | InstanceExtraArgs | Information about node custom parameters Note: This field may return null, indicating that no valid value was found. |
Mounting configuration of the CVM instance data disk
Used by actions: CreateCluster.
| Name | Type | Required | Description |
|---|---|---|---|
| InstanceType | String | Yes | CVM instance type |
| DataDisks | Array of DataDisk | Yes | Data disk mounting information |
| Zone | String | Yes | Availability zone where the CVM instance is located |
Node custom parameter
Used by actions: AddExistedInstances, CreateCluster, CreateClusterAsGroup, CreateClusterInstances, CreateClusterNodePool, DescribeClusterInstances, UpgradeClusterInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| Kubelet | Array of String | No | Kubelet custom parameter, in the format of ["k1=v1", "k1=v2"], for example: ["root-dir=/var/lib/kubelet","feature-gates=PodShareProcessNamespace=true,DynamicKubeletConfig=true"]. Note: this field may return null, indicating that no valid value is obtained. |
Current status of the cluster during node upgrade
Used by actions: GetUpgradeInstanceProgress.
| Name | Type | Description |
|---|---|---|
| PodTotal | Integer | Total Pods |
| NotReadyPod | Integer | Total number of NotReady Pods |
Pre-upgrade check result of a node
Used by actions: GetUpgradeInstanceProgress.
| Name | Type | Description |
|---|---|---|
| CheckPass | Boolean | Whether the check is passed |
| Items | Array of InstanceUpgradePreCheckResultItem | Array of check items |
| SinglePods | Array of String | List of independent pods on this node |
Check result for node upgrade
Used by actions: GetUpgradeInstanceProgress.
| Name | Type | Description |
|---|---|---|
| Namespace | String | The namespace of the workload |
| WorkLoadKind | String | Workload type |
| WorkLoadName | String | Workload name |
| Before | Integer | The number of running pods in the workload before draining the node |
| After | Integer | The number of running pods in the workload after draining the node |
| Pods | Array of String | The pod list of the workload on this node |
Upgrade progress of a node
Used by actions: GetUpgradeInstanceProgress.
| Name | Type | Description |
|---|---|---|
| InstanceID | String | Node instance ID |
| LifeState | String | Task lifecycle process: running paused: stopped pausing: stopping done: completed timeout: timed out aborted: canceled pending: not started |
| StartAt | String | Upgrade start time Note: this field may return null, indicating that no valid value is obtained. |
| EndAt | String | Upgrade end time Note: this field may return null, indicating that no valid value is obtained. |
| CheckResult | InstanceUpgradePreCheckResult | Check result before upgrading |
| Detail | Array of TaskStepInfo | Upgrade steps details |
k8s tags, generally exist as an array
Used by actions: AddExistedInstances, CreateCluster, CreateClusterAsGroup, CreateClusterInstances, CreateClusterNodePool, DescribeClusterAsGroups, DescribeClusterInstances, DescribeClusterNodePoolDetail, DescribeClusterNodePools, ModifyClusterNodePool, UpgradeClusterInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Name in map list |
| Value | String | Yes | Value in map list |
Describes login settings of an instance.
Used by actions: AddExistedInstances, CreateCluster, UpgradeClusterInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| Password | String | No | Login password of the instance. The password requirements vary among different operating systems: If this parameter is not specified, a random password will be generated and sent to you via the Message Center. Note: this field may return null, indicating that no valid value is obtained. |
| KeyIds | Array of String | No | List of key IDs. After an instance is associated with a key, you can access the instance with the private key in the key pair. You can call DescribeKeyPairs to obtain KeyId. A key and password cannot be specified at the same time. Windows instances do not support keys. Currently, you can only specify one key when purchasing an instance.Note: this field may return null, indicating that no valid value is obtained. |
| KeepImageLogin | String | No | Whether to keep the original settings of an image. You cannot specify this parameter and Password or KeyIds.N at the same time. You can specify this parameter as TRUE only when you create an instance using a custom image, a shared image, or an imported image. Valid values: Default value: FALSE. Note: This field may return null, indicating that no valid value is found. |
Nodes that are manually added
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 |
Node statistics list
Used by actions: DescribeClusterNodePoolDetail, DescribeClusterNodePools.
| Name | Type | Description |
|---|---|---|
| ManuallyAdded | ManuallyAdded | Nodes that are manually managed Note: this field may return null, indicating that no valid value is obtained. |
| AutoscalingAdded | AutoscalingAdded | Nodes that are automatically managed Note: this field may return null, indicating that no valid value is obtained. |
Node pool description
Used by actions: DescribeClusterNodePoolDetail, DescribeClusterNodePools.
| Name | Type | Description |
|---|---|---|
| NodePoolId | String | Node pool ID |
| Name | String | Node pool name |
| ClusterInstanceId | String | Cluster instance ID |
| LifeState | String | Status |
| LaunchConfigurationId | String | Launch configuration ID |
| AutoscalingGroupId | String | Auto-scaling group ID |
| Labels | Array of Label | Labels |
| Taints | Array of Taint | Array of taint |
| NodeCountSummary | NodeCountSummary | Node list |
| AutoscalingGroupStatus | String | |
| MaxNodesNum | Integer | Maximum number of nodes Note: this field may return null, indicating that no valid value is obtained. |
| MinNodesNum | Integer | Minimum number of nodes Note: this field may return null, indicating that no valid value is obtained. |
| DesiredNodesNum | Integer | Desired number of nodes Note: this field may return null, indicating that no valid value is obtained. |
| NodePoolOs | String | The operating system of the node pool Note: this field may return null, indicating that no valid value is obtained. |
| OsCustomizeType | String | Container image tag, DOCKER_CUSTOMIZE (container customized tag), GENERAL (general tag, default value)Note: this field may return null, indicating that no valid value is obtained. |
| ImageId | String | Image ID Note: this field may return null, indicating that no valid value is obtained. |
| DesiredPodNum | Integer | This parameter is required when the custom PodCIDR mode is enabled for the cluster. Note: this field may return null, indicating that no valid value is obtained. |
| UserScript | String | Custom script Note: this field may return null, indicating that no valid value is obtained. |
The options for adding the existing node to the node pool
Used by actions: AddExistedInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| AddToNodePool | Boolean | No | Whether to add to the node pool. |
| NodePoolId | String | No | Node pool ID |
| InheritConfigurationFromNodePool | Boolean | No | Whether to inherit the node pool configuration. |
Region information
Used by actions: DescribeRegions.
| Name | Type | Description |
|---|---|---|
| RegionName | String | Region name Note: this field may return null, indicating that no valid values can be obtained. |
| RegionId | Integer | Region ID Note: this field may return null, indicating that no valid values can be obtained. |
| Status | String | Region status Note: this field may return null, indicating that no valid values can be obtained. |
| FeatureGates | String | Status of region-related features (return all attributes in JSON format) Note: this field may return null, indicating that no valid values can be obtained. |
| Alias | String | Region abbreviation Note: this field may return null, indicating that no valid values can be obtained. |
| Remark | String | Whitelisted location Note: this field may return null, indicating that no valid values can be obtained. |
The policy to deal with resources in the cluster when the cluster is deleted.
Used by actions: DeleteCluster.
| Name | Type | Required | Description |
|---|---|---|---|
| ResourceType | String | Yes | Resource type, for example CBS |
| DeleteMode | String | Yes | Specifies the policy to deal with resources in the cluster when the cluster is deleted. It can be terminate or retain. |
Object of cluster route
Used by actions: DescribeClusterRoutes.
| Name | Type | Description |
|---|---|---|
| RouteTableName | String | Route table name. |
| DestinationCidrBlock | String | Destination CIDR. |
| GatewayIp | String | Next hop address. |
Object of route table conflict
Used by actions: DescribeRouteTableConflicts.
| Name | Type | Description |
|---|---|---|
| RouteTableType | String | Route table type. |
| RouteTableCidrBlock | String | Route table CIDR. Note: This field may return null, indicating that no valid values can be obtained. |
| RouteTableName | String | Route table name. Note: This field may return null, indicating that no valid values can be obtained. |
| RouteTableId | String | Route table ID. Note: This field may return null, indicating that no valid values can be obtained. |
Object of cluster route table
Used by actions: DescribeClusterRouteTables.
| Name | Type | Description |
|---|---|---|
| RouteTableName | String | Route table name. |
| RouteTableCidrBlock | String | Route table CIDR. |
| VpcId | String | VPC instance ID. |
Node configuration parameters of different roles
Used by actions: CreateCluster.
| Name | Type | Required | Description |
|---|---|---|---|
| NodeRole | String | Yes | Node role. Values: MASTER_ETCD, WORKER. You only need to specify MASTER_ETCD when creating a self-deployed cluster (INDEPENDENT_CLUSTER). |
| RunInstancesPara | Array of String | Yes | Pass-through parameter for CVM creation in the format of a JSON string. For more information, see the API for creating a CVM instance. Pass any parameter other than common parameters. ImageId will be replaced with the image corresponding to the TKE cluster operating system. |
| InstanceAdvancedSettingsOverrides | Array of InstanceAdvancedSettings | No | An advanced node setting. This parameter overrides the InstanceAdvancedSettings item set at the cluster level and corresponds to RunInstancesPara in a one-to-one sequential manner (currently valid for the ExtraArgs node custom parameter only). |
Describes information related to the Cloud Monitor service.
Used by actions: AddExistedInstances, CreateCluster, UpgradeClusterInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| Enabled | Boolean | No | Whether to enable Cloud Monitor. Valid values: Default value: TRUE. |
Describes information related to the Cloud Security service.
Used by actions: AddExistedInstances, CreateCluster, UpgradeClusterInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| Enabled | Boolean | No | Whether to enable Cloud Security. Valid values: Default value: TRUE. |
The type of resource the label is bound to. Type currently supported is cluster.
Used by actions: CreateCluster, DescribeClusters.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | No | Tag key. |
| Value | String | No | Tag value. |
List of tag descriptions. By specifying this parameter, you can bind tags to corresponding resource instances at the same time. Currently, only tags are bound to cloud host instances.
Used by actions: CreateCluster, DescribeClusters.
| Name | Type | Required | Description |
|---|---|---|---|
| ResourceType | String | No | The type of resource that the tag is bound to. The type currently supported is cluster. |
| Tags | Array of Tag | No | List of tag pairs |
Kubernetes Taint
Used by actions: CreateClusterNodePool, DescribeClusterNodePoolDetail, DescribeClusterNodePools, ModifyClusterNodePool.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | No | Key of the taint |
| Value | String | No | Value of the taint |
| Effect | String | No | Effect of the taint |
Task step information
Used by actions: GetUpgradeInstanceProgress.
| Name | Type | Description |
|---|---|---|
| Step | String | Step name |
| LifeState | String | Lifecycle pending: the step is not started running: the step is in progress success: the step is completed failed: the step failed |
| StartAt | String | Step start time Note: this field may return null, indicating that no valid value is obtained. |
| EndAt | String | Step end time Note: this field may return null, indicating that no valid value is obtained. |
| FailedMsg | String | If the lifecycle of the step is failed, this field will display the error information. Note: this field may return null, indicating that no valid value is obtained. |
Upgradeable node information
Used by actions: CheckInstancesUpgradeAble.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | Node ID |
| Version | String | The current version of the node |
| LatestVersion | String | The latest minor version of the current version Note: this field may return null, indicating that no valid value is obtained. |
Node upgrade and reinstallation parameters
Used by actions: UpgradeClusterInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| InstanceAdvancedSettings | InstanceAdvancedSettings | No | Additional parameters set for the instance |
| EnhancedService | EnhancedService | No | Enhanced services. You can use this parameter to specify whether to enable services such as Cloud Security and Cloud Monitor. If this parameter is not specified, Cloud Monitor and Cloud Security will be enabled by default. |
| LoginSettings | LoginSettings | No | Node login information. For now, it only supports Password or a single KeyIds |
| SecurityGroupIds | Array of String | No | Security group to which the instance belongs. This parameter can be obtained from the sgId field in the response of DescribeSecurityGroups. If this parameter is not specified, the default security group is bound. (Currently, you can only set a single sgId.) |
Was this page helpful?