History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
Add-on description
Used by actions: DescribeAddon.
| Name | Type | Description |
|---|---|---|
| AddonName | String | Add-on name |
| AddonVersion | String | Add-on version |
| RawValues | String | Add-on parameters, which are base64-encoded strings in JSON/ Note: This field may return null, indicating that no valid values can be obtained. |
| Phase | String | Add-on status Note: This field may return null, indicating that no valid values can be obtained. |
| Reason | String | Reason for add-on failure Note: This field may return null, indicating that no valid values can be obtained. |
Annotation
Used by actions: CreateClusterNodePool, DescribeClusterNodePoolDetail, DescribeClusterNodePools, ModifyClusterNodePool.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Annotation Key |
| Value | String | Yes | Annotation Value |
Supported charts for the app.
Used by actions: GetTkeAppChartList.
| Name | Type | Description |
|---|---|---|
| Name | String | chart name. |
| Label | String | Tag of the chart. |
| LatestVersion | String | Version of the chart. |
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 |
Auto-upgrades cluster specification
Used by actions: CreateCluster, ModifyClusterAttribute.
| Name | Type | Required | Description |
|---|---|---|---|
| IsAutoUpgrade | Boolean | Yes | Whether to enable Auto Cluster Upgrade |
Nodes for automatic scaling
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 |
Storage repository information
Used by actions: DescribeBackupStorageLocations.
| Name | Type | Description |
|---|---|---|
| Name | String | Backup repository name |
| StorageRegion | String | Repository region, such as ap-guangzhou |
| Provider | String | The provider of storage service. It defaults to Tencent Cloud. Note: This parameter may return null, indicating that no valid values can be obtained. |
| Bucket | String | COS bucket name. For COS storage type, it must start with the prefix tke-backup. Note: This field may return null, indicating that no valid values can be obtained. |
| Path | String | COS bucket path Note: This field may return null, indicating that no valid values can be obtained. |
| State | String | Storage repository status Note: This field may return null, indicating that no valid values can be obtained. |
| Message | String | Status information Note: This field may return null, indicating that no valid values can be obtained. |
| LastValidationTime | String | Last checked time Note: This parameter may return null, indicating that no valid values can be obtained. |
cuDNN version information
Used by actions: AddExistedInstances, CreateCluster, CreateClusterInstances, CreateClusterNodePool, DescribeClusterNodePoolDetail, DescribeClusterNodePools, ModifyClusterNodePool.
| Name | Type | Required | Description |
|---|---|---|---|
| Version | String | Yes | cuDNN version Note: This field may return "null", indicating that no valid value can be obtained. |
| Name | String | Yes | cuDNN name Note: This field may return "null", indicating that no valid value can be obtained. |
| DocName | String | No | Doc name of cuDNN Note: This field may return "null", indicating that no valid value can be obtained. |
| DevName | String | No | Dev name of cuDNN Note: This field may return "null", indicating that no valid value can be obtained. |
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. Values: Trading (Preparing), Creating, Running, Deleting, Idling (Idle), Recovering, Scaling, Upgrading (Upgrading the cluster), WaittingForConnect (Pending registration), Pause (Cluster upgrade paused), NodeUpgrading (Upgrading the node), RuntimeUpgrading (Upgrading the node runtime), MasterScaling (Scaling Master), ClusterLevelUpgrading (Adjusting cluster specification level), ResourceIsolate (Isolating), ResourceIsolated (Isolated), ResourceReverse (Overdue payment made. Recovering the cluster), and 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. |
| EnableExternalNode | Boolean | Specifies whether the cluster supports external nodes. Note: this field may return null, indicating that no valid value can be obtained. |
| ClusterLevel | String | Cluster models. It’s valid for managed clusters. Note: This field may return null, indicating that no valid values can be obtained. |
| AutoUpgradeClusterLevel | Boolean | The target cluster model for auto-upgrade Note: this field may return null, indicating that no valid value is obtained. |
| QGPUShareEnable | Boolean | Whether to enable qGPU Sharing Note: this field may return null, indicating that no valid values can be obtained. |
| RuntimeVersion | String | Runtime version Note: This field may return null, indicating that no valid value can be obtained. |
| ClusterEtcdNodeNum | Integer | Number of current etcd in the cluster Note: This field may return null, indicating that no valid values can be obtained. |
| CdcId | String | CDC Id Note: This field may return "null", indicating that no valid value can be 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 the ENI type. Values: tke-route-eni (multi-IP shared ENI); tke-direct-eni (independent ENI). It defaults to tke-route-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 |
| CiliumMode | String | No | Specifies whether to enable Cilium. If it’s left empty, Cilium is not enabled. If clusterIP is passed in, it means to enable Cilium to support the clusterIP service type. |
| IsDualStack | Boolean | No | Whether it is a dual-stack cluster in VPC-CNI mode. Default value: false, which indicates it is not a dual-stack cluster. |
| QGPUShareEnable | Boolean | No | Whether to enable qGPU Sharing |
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 | Required | Description |
|---|---|---|---|
| IsScaleDownEnabled | Boolean | No | Whether to enable scale-in Note: this field may return null, indicating that no valid value was found. |
| Expander | String | No | 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 | No | Max concurrent scale-in volume Note: this field may return null, indicating that no valid value was found. |
| ScaleDownDelay | Integer | No | 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 | No | 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 | No | 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 | No | Do not scale in a node if it contains local storage Pods. Default: true.Note: This field may return null, indicating that no valid values can be obtained. |
| SkipNodesWithSystemPods | Boolean | No | Do not scale in a node if it contains Pods in the kube-system namespace that are not managed by DaemonSet. Default: true.Note: This field may return null, indicating that no valid values can be obtained. |
| IgnoreDaemonSetsUtilization | Boolean | No | 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 | No | 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 | No | 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 | No | 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 | No | 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. Public image (enter the image name) and custom image (enter the image ID) are supported. For details, see https://www.tencentcloud.com/document/product/457/68289?from_cn_redirect=1 |
| 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, Alpha feature) |
| SubnetId | String | No | When the Cilium Overlay add-on is selected, TKE will take two IPs from the subnet to create the private network CLB. |
| ClusterLevel | String | No | Cluster specifications available for managed clusters |
| AutoUpgradeClusterLevel | AutoUpgradeClusterLevel | No | Auto cluster upgrade for managed clusters |
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. Value range: 16 to 256. When its power is not 2, it will round upward to the closest power of 2. |
| MaxClusterServiceNum | Integer | No | The maximum number of services in a cluster. The range is from 32 to 32768. When its power is not 2, it will round upward to the closest power of 2. Default value is 256. |
| 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) |
| IgnoreServiceCIDRConflict | Boolean | No | Whether to ignore ServiceCIDR conflict errors. It is only valid in VPC-CNI mode. Default value: false. |
Cluster creation process
Used by actions: DescribeTKEEdgeClusterStatus.
| Name | Type | Description |
|---|---|---|
| Type | String | Process type |
| Status | String | Process status |
| LastProbeTime | Timestamp | Last time when the status is probed Note: This field may return null, indicating that no valid values can be obtained. |
| LastTransitionTime | Timestamp | Last time when transiting to the process Note: This field may return null, indicating that no valid values can be obtained. |
| Reason | String | Reasons for transiting to the process Note: This field may return null, indicating that no valid values can be obtained. |
| Message | String | More information on transition Note: This field may return null, indicating that no valid values can be obtained. |
Authentication information for accessing K8s
Used by actions: DescribeTKEEdgeClusterCredential.
| Name | Type | Required | Description |
|---|---|---|---|
| CACert | String | Yes | CA root certificate |
| Token | String | No | Token for authentication |
Cluster master custom parameter
Used by actions: CreateCluster, DescribeClusterExtraArgs, 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. |
Information of the managed cluster model
Used by actions: DescribeClusterLevelAttribute.
| Name | Type | Description |
|---|---|---|
| Name | String | Cluster model |
| Alias | String | Model name |
| NodeCount | Integer | Number of nodes |
| PodCount | Integer | Number of Pods |
| ConfigMapCount | Integer | Number of ConfigMap |
| RSCount | Integer | Number of ReplicaSets |
| CRDCount | Integer | Number of CRDs |
| Enable | Boolean | Whether it is enabled |
| OtherCount | Integer | Number of other resources Note: This field may return null, indicating that no valid values can be obtained. |
Cluster model adjustment history
Used by actions: DescribeClusterLevelChangeRecords.
| Name | Type | Description |
|---|---|---|
| ID | String | Record ID |
| ClusterID | String | Cluster ID |
| Status | String | Status (valid values: trading, upgrading, success, failed) |
| Message | String | Status description |
| OldLevel | String | Original model |
| NewLevel | String | New model |
| TriggerType | String | Trigger type (valid values: manual, auto) |
| CreatedAt | String | Creation time |
| StartedAt | String | Start time |
| EndedAt | String | End time |
Cluster network-related parameters
Used by actions: DescribeClusters.
| Name | Type | Description |
|---|---|---|
| ClusterCIDR | String | 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 | Whether to ignore ClusterCIDR conflict errors. It defaults to not ignore. |
| MaxNodePodNum | Integer | Maximum number of pods on each node in the cluster. Default value: 256 |
| MaxClusterServiceNum | Integer | Maximum number of cluster services. Default value: 256 |
| Ipvs | Boolean | Whether IPVS is enabled. Default value: disabled |
| VpcId | String | 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 | Whether CNI is enabled for network plugin(s). Default value: enabled |
| KubeProxyMode | String | The network mode of service. This parameter is only applicable to ipvs+bpf mode. Note: this field may return null, indicating that no valid value can be obtained. |
| ServiceCIDR | String | The IP range for service assignment. It cannot conflict with the VPC’s CIDR block nor the CIDR blocks of other clusters in the same VPC. Note: this field may return null, indicating that no valid value can be obtained. |
| Subnets | Array of String | The container subnet associated with the cluster Note: this field may return null, indicating that no valid value can be obtained. |
| IgnoreServiceCIDRConflict | Boolean | Whether to ignore ServiceCIDR conflict errors. It is only valid in VPC-CNI mode. Default value: false.Note: This field may return null, indicating that no valid value can be obtained. |
| IsDualStack | Boolean | Whether it is a dual-stack cluster in VPC-CNI mode. Default value: false, which indicates it is not a dual-stack cluster.Note: This field may return null, indicating that no valid value can be obtained. |
| Ipv6ServiceCIDR | String | It is used to automatically assign the IP ranges for the service. Note: This field may return null, indicating that no valid value can be obtained. |
| CiliumMode | String | Cluster Cilium Mode configuration - clusterIP Note: This field may return null, indicating that no valid value can be obtained. |
Cluster attributes
Used by actions: ModifyClusterAttribute.
| Name | Type | Required | Description |
|---|---|---|---|
| NodeNameType | String | No | Node hostname naming pattern Note: This field may return "null", indicating that no valid value can be obtained. |
Cluster status information
Used by actions: DescribeClusterStatus.
| Name | Type | Description |
|---|---|---|
| ClusterId | String | Cluster ID |
| ClusterState | String | Cluster status |
| ClusterInstanceState | String | Status of nodes in the cluster |
| ClusterBMonitor | Boolean | Indicates whether the monitoring service is enabled for the cluster |
| ClusterInitNodeNum | Integer | Number of cluster nodes being created. "-1" indicates that the request to obtain the node status timed out. "-2" indicates that the request failed. |
| ClusterRunningNodeNum | Integer | Number of running nodes in the cluster. "-1" indicates that the request to obtain the node status timed out. "-2" indicates that the request failed. |
| ClusterFailedNodeNum | Integer | Number of abnormal nodes in the cluster. "-1" indicates that the request to obtain the node status timed out. "-2" indicates that the request failed. |
| ClusterClosedNodeNum | Integer | Number of shutdown nodes in the cluster. "-1" indicates that the request to obtain the node status timed out. "-2" indicates that the request failed. Note: this field may return null, indicating that no valid value can be found. |
| ClusterClosingNodeNum | Integer | Number of nodes being shut down in the cluster. "-1" indicates that the request to obtain the node status timed out. "-2" indicates that the request failed. Note: this field may return null, indicating that no valid value can be found. |
| ClusterDeletionProtection | Boolean | Indicates whether to enable cluster deletion protection Note: this field may return null, indicating that no valid value can be found. |
| ClusterAuditEnabled | Boolean | Indicates whether the cluster is auditable Note: this field may return null, indicating that no valid value can be found. |
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 |
The CommonName in the certificate of the client corresponding to the user UIN
Used by actions: DescribeClusterCommonNames.
| Name | Type | Description |
|---|---|---|
| SubaccountUin | String | User UIN |
| CN | String | The CommonName in the certificate of the client corresponding to the sub-account |
Component log collection configuration.
Used by actions: DescribeControlPlaneLogs, EnableControlPlaneLogs.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Component name |
| LogLevel | Integer | No | Log level. for components that support dynamic adjustment, you can specify this parameter when enabling logs. |
| LogSetId | String | No | Logset ID. if not specified, auto-create. |
| TopicId | String | No | Log topic ID. if not specified, auto-create. |
| TopicRegion | String | No | topic region. this parameter enables cross-region shipping of logs. |
Custom driver information
Used by actions: AddExistedInstances, CreateCluster, CreateClusterInstances, CreateClusterNodePool, DescribeClusterNodePoolDetail, DescribeClusterNodePools, ModifyClusterNodePool.
| Name | Type | Required | Description |
|---|---|---|---|
| Address | String | No | URL of custom GPU driver address Note: This field may return null, indicating that no valid values can be obtained. |
Described the configuration and information of k8s node data disk.
Used by actions: AddExistedInstances, CreateCluster, CreateClusterInstances, CreateClusterNodePool, DescribeClusterNodePoolDetail, DescribeClusterNodePools.
| Name | Type | Required | Description |
|---|---|---|---|
| DiskType | String | Yes | Disk type Note: this field may return null, indicating that no valid values can be obtained. |
| FileSystem | String | Yes | File system (ext3/ext4/xfs) Note: This field may return null, indicating that no valid value was found. |
| DiskSize | Integer | Yes | Disk size (G) Note: This field may return null, indicating that no valid value was found. |
| AutoFormatAndMount | Boolean | Yes | Whether the disk is auto-formatted and mounted Note: this field may return null, indicating that no valid value is obtained. |
| MountTarget | String | Yes | Mounting directory Note: This field may return null, indicating that no valid value was found. |
| DiskPartition | String | Yes | Mounted device name or partition name (only required when adding an existing node) Note: This field may return null, indicating that no valid values can be obtained. |
Version information of GPU driver and CUDA
Used by actions: AddExistedInstances, CreateCluster, CreateClusterInstances, CreateClusterNodePool, DescribeClusterNodePoolDetail, DescribeClusterNodePools, ModifyClusterNodePool.
| Name | Type | Required | Description |
|---|---|---|---|
| Version | String | Yes | Version of GPU driver or CUDA Note: This field may return "null", indicating that no valid value can be obtained. |
| Name | String | Yes | Name of GPU driver or CUDA Note: This field may return "null", indicating that no valid value can be obtained. |
ECM enhanced services
Used by actions: CreateECMInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| SecurityService | ECMRunMonitorServiceEnabled | No | Whether Cloud Monitoring is enabled |
| MonitorService | ECMRunSecurityServiceEnabled | No | Whether Cloud Workload Protection is enabled |
ECM Cloud Monitoring
Used by actions: CreateECMInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| Enabled | Boolean | No | Whether it is enabled |
ECM Cloud Workload Protection
Used by actions: CreateECMInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| Enabled | Boolean | No | Whether it is enabled |
| Version | Integer | No | CWP version. Valid values: 0 (CWP Pro), 1 (CWP Pro) |
Combination of the ECM instance AZ, number of instances, and ISP
Used by actions: CreateECMInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| Zone | String | Yes | Instance AZ |
| InstanceCount | Integer | Yes | Number of instances to be created in the current AZ |
| ISP | String | Yes | ISP |
Edge cluster parameters
Used by actions: DescribeEdgeAvailableExtraArgs.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | No | Parameter name Note: This field may return null, indicating that no valid values can be obtained. |
| Type | String | No | Parameter type Note: This field may return null, indicating that no valid values can be obtained. |
| Usage | String | No | Parameter description Note: This field may return null, indicating that no valid values can be obtained. |
| Default | String | No | Default value of the parameter Note: This field may return null, indicating that no valid values can be obtained. |
| Constraint | String | No | Valid value or range. Options: [] (it indicates a range, for example, “[1, 5]” indicates the parameter must be equal or larger than 1, and be equal or smaller than 5), and () (it indicates a valid value, for example, “('aa', 'bb')” indicates the parameter must be “aa” or “bb”. If it is left empty, the verification can be skipped.)Note: This field may return null, indicating that no valid values can be obtained. |
Custom parameters available for the edge cluster
Used by actions: DescribeEdgeAvailableExtraArgs.
| Name | Type | Required | Description |
|---|---|---|---|
| KubeAPIServer | Array of EdgeArgsFlag | No | kube-apiserver custom parameter Note: This field may return null, indicating that no valid values can be obtained. |
| KubeControllerManager | Array of EdgeArgsFlag | No | kube-controller-manager custom parameter Note: This field may return null, indicating that no valid values can be obtained. |
| KubeScheduler | Array of EdgeArgsFlag | No | kube-scheduler custom parameter Note: This field may return null, indicating that no valid values can be obtained. |
| Kubelet | Array of EdgeArgsFlag | No | kubelet custom parameter Note: This field may return null, indicating that no valid values can be obtained. |
Edge compute cluster information
Used by actions: DescribeTKEEdgeClusters.
| Name | Type | Required | Description |
|---|---|---|---|
| ClusterId | String | Yes | Cluster ID |
| ClusterName | String | Yes | Cluster name |
| VpcId | String | Yes | VPC ID |
| PodCIDR | String | Yes | Cluster Pod CIDR block |
| ServiceCIDR | String | Yes | Cluster service CIDR block |
| K8SVersion | String | Yes | |
| Status | String | No | Cluster status |
| ClusterDesc | String | No | Cluster description |
| CreatedTime | String | No | Cluster creation time |
| EdgeClusterVersion | String | No | Edge cluster version |
| MaxNodePodNum | Integer | No | Maximum number of Pods on the node Note: This field may return null, indicating that no valid values can be obtained. |
| ClusterAdvancedSettings | EdgeClusterAdvancedSettings | No | Cluster advanced settings Note: This field may return null, indicating that no valid values can be obtained. |
| Level | String | No | TKE edge cluster level Note: This field may return null, indicating that no valid values can be obtained. |
| AutoUpgradeClusterLevel | Boolean | No | Whether to support auto upgrade of cluster spec level Note: This field may return null, indicating that no valid values can be obtained. |
| ChargeType | String | No | Cluster billing mode. Valid values: POSTPAID_BY_HOUR, PREPAIDNote: This field may return null, indicating that no valid values can be obtained. |
| EdgeVersion | String | No | Edge cluster component version Note: This field may return null, indicating that no valid values can be obtained. |
| TagSpecification | TagSpecification | No | Tags bound with the cluster Note: This field may return null, indicating that no valid values can be obtained. |
Edge cluster advanced settings
Used by actions: CreateTKEEdgeCluster, DescribeTKEEdgeClusters.
| Name | Type | Required | Description |
|---|---|---|---|
| ExtraArgs | EdgeClusterExtraArgs | No | Custom parameters of the cluster Note: This field may return null, indicating that no valid values can be obtained. |
| Runtime | String | No | Runtime type. Valid values: "docker" (default), "containerd". Note: This field may return null, indicating that no valid values can be obtained. |
| ProxyMode | String | No | Forwarding mode of kube-proxy. Valid values: "iptables" (default), "ipvs". Note: This field may return null, indicating that no valid values can be obtained. |
Edge cluster master custom parameters
Used by actions: CreateTKEEdgeCluster, DescribeEdgeClusterExtraArgs, DescribeTKEEdgeClusters.
| 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 values can be obtained. |
| KubeControllerManager | Array of String | No | kube-controller-manager custom parameter Note: This field may return null, indicating that no valid values can be obtained. |
| KubeScheduler | Array of String | No | kube-scheduler custom parameter Note: This field may return null, indicating that no valid values can be obtained. |
Edge compute cluster private LB information
Used by actions: DescribeTKEEdgeClusterCredential.
| Name | Type | Required | Description |
|---|---|---|---|
| Enabled | Boolean | Yes | Whether the private LB is enabled Note: This field may return null, indicating that no valid values can be obtained. |
| SubnetId | Array of String | No | ID of the subnet associated with the private LB Note: This field may return null, indicating that no valid values can be obtained. |
Edge compute cluster public LB information
Used by actions: CreateTKEEdgeCluster, DescribeTKEEdgeClusterCredential.
| Name | Type | Required | Description |
|---|---|---|---|
| Enabled | Boolean | Yes | Whether the public LB is enabled Note: This field may return null, indicating that no valid values can be obtained. |
| AllowFromCidrs | Array of String | No | Public network CIDR block allowed to access Note: This field may return null, indicating that no valid values can be obtained. |
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. |
| AutomationService | RunAutomationServiceEnabled | No | Whether to enable the TAT service. If this parameter is not specified, the TAT service is enabled for public images and disabled for other images 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. |
| IPv6Addresses | Array of String | IPv6 address of the instance Note: This field may return null, indicating that no valid values can be obtained.Note: This field may return null, indicating that no valid values can be obtained. |
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) |
| DesiredPodNumbers | Array of Integer | No | When the custom PodCIDR mode is enabled for the cluster, you can specify the maximum number of pods per node. |
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 information required for the instance (currently not supported by the backend, we will implement this in future versions) |
| 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) |
Resource failed to modify the Tag.
Used by actions: DescribeBatchModifyTagsStatus.
| Name | Type | Description |
|---|---|---|
| Resource | String | 6-Segment resource Note: This field may return "null", indicating that no valid value can be obtained. |
| Error | String | Reason for execution failure Note: This field may return "null", indicating that no valid value can be obtained. |
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, DescribeClusterInstances, DescribeClusterNodePools, DescribeClusterRoutes, DescribeClusters, DescribeECMInstances, DescribeEdgeCVMInstances, DescribeEdgeClusterInstances, DescribeExistedInstances, DescribeTKEEdgeClusters.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Filters. |
| Values | Array of String | Yes | Filter values. |
GPU parameters, including GPU driver version, CDUA version, cuDNN version and whether to enable MIG.
Used by actions: AddExistedInstances, CreateCluster, CreateClusterInstances, CreateClusterNodePool, DescribeClusterNodePoolDetail, DescribeClusterNodePools, ModifyClusterNodePool.
| Name | Type | Required | Description |
|---|---|---|---|
| MIGEnable | Boolean | No | Whether to enable MIG Note: This field may return null, indicating that no valid values can be obtained. |
| Driver | DriverVersion | No | GPU driver version |
| CUDA | DriverVersion | No | CUDA version Note: This field may return null, indicating that no valid values can be obtained. |
| CUDNN | CUDNN | No | cuDNN version Note: This field may return null, indicating that no valid values can be obtained. |
| CustomDriver | CustomDriver | No | Custom GPU driver Note: This field may return null, indicating that no valid values can be obtained. |
IP Address
Used by actions: DescribeTKEEdgeClusterCredential.
| Name | Type | Required | Description |
|---|---|---|---|
| Type | String | Yes | Type. Valid values: advertise, public, and others |
| Ip | String | Yes | IP Address |
| Port | Integer | Yes | Network port |
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, CreateClusterInstances, CreateClusterNodePool, DescribeClusterInstances, UpgradeClusterInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| DesiredPodNumber | Integer | Yes | When the custom PodCIDR mode is enabled for the cluster, you can specify the maximum number of pods per node. Note: this field may return null, indicating that no valid values can be obtained. |
| GPUArgs | GPUArgs | Yes | GPU driver-related parameters. Relevant GPU parameters can be found at: https://www.tencentcloud.com/document/api/213/15715?from_cn_redirect=1 Note: This field may return "null", indicating that no valid value can be obtained. |
| PreStartUserScript | String | Yes | Specifies the base64-encoded custom script to be executed before initialization of the node. It’s only valid for adding existing nodes for now. Note: this field may return null, indicating that no valid values can be obtained. |
| Taints | Array of Taint | Yes | Node taint Note: This field may return null, indicating that no valid value can be obtained. |
| MountTarget | String | No | 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 | No | 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 | No | 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 | No | 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 | No | Node label array Note: This field may return null, indicating that no valid value was found. |
| DataDisks | Array of DataDisk | No | Mounting information of multiple data disks. When you create a node, ensure that the CVM purchase parameter specifies the information required for the purchase of multiple data disks. For example, the DataDisks under RunInstancesPara of the CreateClusterInstances API should be configured accordingly (Referto document of CreateClusterInstances API). When you add an existing node, ensure that the specified partition exists in the node.Note: this field may return null, indicating that no valid values can be obtained. |
| ExtraArgs | InstanceExtraArgs | No | 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, CreateClusterInstances, CreateClusterNodePool, DescribeClusterNodePoolDetail, DescribeClusterNodePools, ModifyClusterNodePool.
| 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 |
KMS encryption parameters
Used by actions: EnableEncryptionProtection.
| Name | Type | Required | Description |
|---|---|---|---|
| KeyId | String | No | KMS ID |
| KmsRegion | String | No | KMS region |
k8s tags, generally exist as an array
Used by actions: AddExistedInstances, CreateCluster, CreateClusterInstances, CreateClusterNodePool, CreateClusterVirtualNodePool, CreatePrometheusAlertRule, DescribeClusterAsGroups, DescribeClusterNodePoolDetail, DescribeClusterNodePools, DescribeClusterVirtualNodePools, ModifyClusterNodePool, ModifyClusterVirtualNodePool, ModifyPrometheusAlertRule.
| 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. If it's not specified, the user needs to set the login password using the *Reset password** option in the CVM console or calling the API ResetInstancesPassword to complete the creation of the CVM instance(s).Note: This field may return null, indicating that no valid values can be 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. You cannot specify a key and a password at the same time. Windows instances do not support keys.Note: This field may return null, indicating that no valid values can be obtained. |
| KeepImageLogin | String | No | Maintains the original settings of the image. This parameter cannot be specified simultaneously with Password or KeyIds.N. It can be set to true only when an instance is created with a custom image, shared image, or externally imported image. Valid values: 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 | The lifecycle state of the current node pool. Valid values: creating, normal, updating, deleting, and deleted. |
| LaunchConfigurationId | String | Launch configuration ID |
| AutoscalingGroupId | String | Auto-scaling group ID |
| Labels | Array of Label | Labels |
| Taints | Array of Taint | Array of taint |
| Annotations | Array of AnnotationValue | Node Annotation List |
| 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. |
| RuntimeConfig | RuntimeConfig | Runtime Description Note: This field may return "null", indicating that no valid value can be 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. |
| Tags | Array of Tag | Resource tag Note: this field may return null, indicating that no valid values can be obtained. |
| DeletionProtection | Boolean | Whether Deletion Protection is enabled Note: this field may return null, indicating that no valid values can be obtained. |
| ExtraArgs | InstanceExtraArgs | Node Configuration Note: This field may return "null", indicating that no valid value can be obtained. |
| GPUArgs | GPUArgs | GPU Driver-related Parameters Note: This field may return "null", indicating that no valid value 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 can be obtained. |
| DataDisks | Array of DataDisk | Multiple Disk Data Disk Mount Information: When creating a new node, make sure that the CVM purchase parameters include the information of purchasing multiple data disks. For example, in the DataDisks under RunInstancesPara of CreateClusterInstances API, it must also be set to purchase multiple data disks. Refer to the example of adding cluster nodes (multiple data disks) of CreateClusterInstances API; when adding existing nodes, ensure that the specified partition information actually exists on the node. Note: This field may return "null", indicating that no valid value can be obtained. |
| Unschedulable | Integer | Unschedulable or not Note: This field may return "null", indicating that no valid value can be obtained. |
| PreStartUserScript | String | Custom script, executed before UserScript Note: This field may return "null", indicating that no valid value can be 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. |
NodePool Runtime Configuration
Used by actions: ModifyClusterRuntimeConfig.
| Name | Type | Required | Description |
|---|---|---|---|
| NodePoolId | String | No | Node pool ID Note: This field may return "null", indicating that no valid value can be obtained. |
| RuntimeType | String | No | Runtime type Note: This field may return "null", indicating that no valid value can be obtained. |
| RuntimeVersion | String | No | Runtime version Note: This field may return "null", indicating that no valid value can be obtained. |
| NodePoolName | String | No | Node pool name Note: This field may return "null", indicating that no valid value can be obtained. |
OIDC authentication related configurations
Used by actions: DescribeClusterAuthenticationOptions, ModifyClusterAuthenticationOptions.
| Name | Type | Required | Description |
|---|---|---|---|
| AutoCreateOIDCConfig | Boolean | No | Creating an identity provider Note: This field may return null, indicating that no valid value can be obtained. |
| AutoCreateClientId | Array of String | No | Creating ClientId of the identity provider Note: This field may return null, indicating that no valid value can be obtained. |
| AutoInstallPodIdentityWebhookAddon | Boolean | No | Creating the PodIdentityWebhook component Note: This field may return null, indicating that no valid value can be obtained. |
Optional runtime
Used by actions: DescribeSupportedRuntime.
| Name | Type | Required | Description |
|---|---|---|---|
| RuntimeType | String | No | Runtime type Note: This field may return "null", indicating that no valid value can be obtained. |
| RuntimeVersions | Array of String | No | Runtime version list Note: This field may return "null", indicating that no valid value can be obtained. |
| DefaultVersion | String | No | Default runtime version for this type Note: This field may return "null", indicating that no valid value can be obtained. |
Pod billing information.
Used by actions: DescribePodChargeInfo.
| Name | Type | Description |
|---|---|---|
| StartTime | String | Pod billing start time |
| Uid | String | UID of the pod. |
| Cpu | Float | Pod CPU |
| Memory | Float | Pod Memory |
| Type | String | Pod Type: intel, amd, v100, t4, a10*gnv4, a10*gnv4v, and so on. |
| Gpu | String | If the Pod is a GPU, then it indicates the number of GPU cards Note: This field may return "null", indicating that no valid value can be obtained. |
| ChargeType | String | Billing type PREPAID: Pod scheduled to monthly subscription super node POSTPAID_BY_HOUR: Pay-as-you-go RESERVED_INSTANCE: Deducted by reserved coupon in the previous period SPOT: Bidding instance TPOD: Preference instance |
| Namespace | String | Namespace |
| Name | String | Pod name |
The maximum number of Pods in VPC-CNI mode supported by a model
Used by actions: DescribeVpcCniPodLimits.
| Name | Type | Description |
|---|---|---|
| TKERouteENINonStaticIP | Integer | The number of Pods supported by a TKE shared ENI in non-static IP address mode Note: this field may return null, indicating that no valid value can be obtained. |
| TKERouteENIStaticIP | Integer | The number of Pods supported by a TKE shared ENI in static IP address mode Note: this field may return null, indicating that no valid value can be obtained. |
| TKEDirectENI | Integer | The number of Pods supported by TKE independent ENI mode Note: this field may return null, indicating that no valid value can be obtained. |
| TKESubENI | Integer | Number of Pods supported by TKE relay network card mode Note: This field may return "null", indicating that no valid value can be obtained. |
The model information and the maximum supported number of Pods in the VPC-CNI mode
Used by actions: DescribeVpcCniPodLimits.
| Name | Type | Description |
|---|---|---|
| Zone | String | The availability zone where the model is located Note: this field may return null, indicating that no valid value can be obtained. |
| InstanceFamily | String | The instance family to which the model belongs Note: this field may return null, indicating that no valid value can be obtained. |
| InstanceType | String | Instance type Note: this field may return null, indicating that no valid value can be obtained. |
| PodLimits | PodLimitsByType | The maximum number of Pods in the VPC-CNI mode supported by the model Note: this field may return null, indicating that no valid value can be obtained. |
PROM instance alarm rule
Used by actions: CreatePrometheusAlertRule, ModifyPrometheusAlertRule.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Rule name |
| Rule | String | Yes | PromQL contents |
| Labels | Array of Label | Yes | Additional labels |
| Template | String | Yes | Alarm delivery template |
| For | String | Yes | Duration |
| Describe | String | No | Rule description Note: this field may return null, indicating that no valid value can be obtained. |
| Annotations | Array of Label | No | Refer to annotations in prometheus rule Note: this field may return null, indicating that no valid value can be obtained. |
| RuleState | Integer | No | Alarm rule status Note: this field may return null, indicating that no valid values can be obtained. |
The alarm configuration
Used by actions: CreatePrometheusAlertRule, ModifyPrometheusAlertRule.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Rule name |
| Rules | Array of PrometheusAlertRule | Yes | Rule list |
| UpdatedAt | String | No | Last modification time |
| Notification | PrometheusNotification | No | Alarm delivery methods |
| Id | String | No | Alarm rule ID |
| TemplateId | String | No | If the alarm is delivered via a template, the TemplateId is the template ID. Note: this field may return null, indicating that no valid value can be obtained. |
| Interval | String | No | Alarm interval Note: this field may return null, indicating that no valid value can be obtained. |
The grafana information in the managed PROM instance
Used by actions: DescribePrometheusInstance.
| Name | Type | Description |
|---|---|---|
| Enabled | Boolean | Whether it is enabled |
| Domain | String | Domain name. It will be effective only when the public network access is enabled. |
| Address | String | The private network or public network address |
| Internet | String | Whether the public network access is enabled.close: the public network access is not enabledopening: the public network access is being enabledopen: the public network access is enabled |
| AdminUser | String | The user name of the grafana admin |
amp alarm channel configuration
Used by actions: CreatePrometheusAlertRule, ModifyPrometheusAlertRule.
| Name | Type | Required | Description |
|---|---|---|---|
| Enabled | Boolean | Yes | Whether it is enabled |
| RepeatInterval | String | Yes | Convergence time |
| TimeRangeStart | String | Yes | Start time |
| TimeRangeEnd | String | Yes | End time |
| NotifyWay | Array of String | No | Alarm delivery method. Valid values: SMS, EMAIL, CALL, and WECHATIt respectively represents SMS, email, phone calls, and WeChat. Note: this field may return null, indicating that no valid value can be obtained. |
| ReceiverGroups | Array of Integer | No | The alarm recipient group (user group) Note: this field may return null, indicating that no valid value can be obtained. |
| PhoneNotifyOrder | Array of Integer | No | The alarm sequence of phone calls This parameter is used when you specify CALL for NotifyWay.Note: this field may return null, indicating that no valid value can be obtained. |
| PhoneCircleTimes | Integer | No | The number of phone call alarms This parameter is used when you specify CALL for NotifyWay.Note: this field may return null, indicating that no valid value can be obtained. |
| PhoneInnerInterval | Integer | No | Dialing interval in seconds within one polling This parameter is used when you specify CALL for NotifyWay.Note: this field may return null, indicating that no valid value can be obtained. |
| PhoneCircleInterval | Integer | No | Polling interval in seconds This parameter is used when you specify CALL for NotifyWay.Note: this field may return null, indicating that no valid value can be obtained. |
| PhoneArriveNotice | Boolean | No | Phone call alarm arrival notification This parameter is used when you specify CALL for NotifyWay.Note: this field may return null, indicating that no valid value can be obtained. |
| Type | String | No | Channel type. Default value: amp. The following channels are supported:amp webhook Note: this field may return null, indicating that no valid value can be obtained. |
| WebHook | String | No | This parameter is required if Type is webhook.Note: this field may return null, indicating that no valid value can be obtained. |
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. |
Usage rate information of Reserved Coupons
Used by actions: DescribeReservedInstanceUtilizationRate.
| Name | Type | Description |
|---|---|---|
| Rate | Float | Usage rate Note: This field may return "null", indicating that no valid value can be obtained. |
| Num | Integer | Quantity of Reserved Coupons Note: This field may return "null", indicating that no valid value can be obtained. |
| CPU | Float | Number of cores Note: This field may return "null", indicating that no valid value can be obtained. |
| Memory | Float | Memory Note: This field may return "null", indicating that no valid value can be obtained. |
| Type | String | Type of Reserved Coupons Note: This field may return "null", indicating that no valid value can be obtained. |
| GpuNum | String | Number of GPU cards Note: This field may return "null", indicating that no valid value can be obtained. |
| Zone | String | Availability zone Note: This field may return "null", indicating that no valid value can be obtained. |
| ClusterId | String | Cluster ID Note: This field may return "null", indicating that no valid value can be obtained. |
| NodeName | String | Node name Note: This field may return "null", indicating that no valid value can be obtained. |
| PodNum | Integer | Number of Pods Note: This field may return "null", indicating that no valid value 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, such as CBS, CLB, CVM |
| DeleteMode | String | Yes | Deletion mode for CBS resources when the cluster is deleted: terminate, retain. Other resources are terminated by default. |
| SkipDeletionProtection | Boolean | No | Whether to skip the resources with deletion protection enabled. It is false by default. When set to true, the resources with deletion protection enabled are not cleaned up. CLB with terminal nodes also belongs to the resources with deletion protection enabled. |
Cluster resource usage
Used by actions: DescribeResourceUsage.
| Name | Type | Description |
|---|---|---|
| Name | String | Resource type |
| Usage | Integer | Resource usage |
| Details | Array of ResourceUsageDetail | Resource usage details |
Resource usage details
Used by actions: DescribeResourceUsage.
| Name | Type | Description |
|---|---|---|
| Name | String | Resource name |
| Usage | Integer | Resource usage |
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. |
Describes the TAT service information.
Used by actions: AddExistedInstances, UpgradeClusterInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| Enabled | Boolean | No | Whether to enable the TAT service. Valid values: TRUE: yes;FALSE: noDefault: FALSE. |
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, 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, UpgradeClusterInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| Enabled | Boolean | No | Whether to enable Cloud Security. Valid values: Default value: TRUE. |
Runtime configuration
Used by actions: DescribeClusterNodePoolDetail, DescribeClusterNodePools, ModifyClusterRuntimeConfig.
| Name | Type | Required | Description |
|---|---|---|---|
| RuntimeType | String | No | Runtime type Note: This field may return "null", indicating that no valid value can be obtained. |
| RuntimeVersion | String | No | Runtime version Note: This field may return "null", indicating that no valid value can be obtained. |
ServiceAccount authentication configuration
Used by actions: DescribeClusterAuthenticationOptions, ModifyClusterAuthenticationOptions.
| Name | Type | Required | Description |
|---|---|---|---|
| UseTKEDefault | Boolean | No | Use TKE default issuer and jwksuri Note: This field may return null, indicating that no valid values can be obtained. |
| Issuer | String | No | service-account-issuer Note: this field may return null, indicating that no valid values can be obtained. |
| JWKSURI | String | No | service-account-jwks-uri Note: this field may return null, indicating that no valid values can be obtained. |
| AutoCreateDiscoveryAnonymousAuth | Boolean | No | If it is set to true, a RABC rule is automatically created to allow anonymous users to access /.well-known/openid-configuration and /openid/v1/jwks.Note: this field may return null, indicating that no valid values can be obtained. |
Execution Step Information
Used by actions: DescribeExternalNodeSupportConfig.
| Name | Type | Description |
|---|---|---|
| Name | String | Name |
| StartAt | String | Start time Note: This field may return "null", indicating that no valid value can be obtained. |
| EndAt | String | End time Note: This field may return "null", indicating that no valid value can be obtained. |
| Status | String | Current status Note: This field may return "null", indicating that no valid value can be obtained. |
| Message | String | Execution Information Note: This field may return "null", indicating that no valid value can be obtained. |
Cluster log switch collection
Used by actions: DescribeLogSwitches.
| Name | Type | Description |
|---|---|---|
| ClusterId | String | Cluster ID |
| Audit | SwitchInfo | Details of the audit switch Note: This field may return "null", indicating that no valid value can be obtained. |
| Event | SwitchInfo | Details of the event switch Note: This field may return "null", indicating that no valid value can be obtained. |
| Log | SwitchInfo | Details of common logs Note: This field may return "null", indicating that no valid value can be obtained. |
| MasterLog | SwitchInfo | Details of master log Note: This field may return "null", indicating that no valid value can be obtained. |
Log Switch Details
Used by actions: DescribeLogSwitches.
| Name | Type | Description |
|---|---|---|
| Enable | Boolean | Enables Identifier. true means enabled. Note: This field may return "null", indicating that no valid value can be obtained. |
| LogsetId | String | CLS Logset ID Note: This field may return "null", indicating that no valid value can be obtained. |
| TopicId | String | CLS Log Topic ID Note: This field may return "null", indicating that no valid value can be obtained. |
| Version | String | Current log-agent Version Note: This field may return "null", indicating that no valid value can be obtained. |
| UpgradeAble | Boolean | Upgradable or not Note: This field may return "null", indicating that no valid value can be obtained. |
| TopicRegion | String | CLS Log Topic Region Note: This field may return "null", indicating that no valid value can be obtained. |
The type of resource the label is bound to. Type currently supported is cluster.
Used by actions: CreateCluster, CreateClusterNodePool, CreateClusterVirtualNode, CreateClusterVirtualNodePool, CreateTKEEdgeCluster, DescribeBatchModifyTagsStatus, DescribeClusterNodePoolDetail, DescribeClusterNodePools, DescribeClusters, DescribeTKEEdgeClusters, ModifyClusterNodePool, ModifyClusterTags.
| 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, CreateTKEEdgeCluster, DescribeClusters, DescribeTKEEdgeClusters.
| 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: AddExistedInstances, CreateCluster, CreateClusterInstances, CreateClusterNodePool, CreateClusterVirtualNodePool, DescribeClusterNodePoolDetail, DescribeClusterNodePools, DescribeClusterVirtualNodePools, ModifyClusterNodePool, ModifyClusterVirtualNodePool.
| 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. |
Reason for unavailability
Used by actions: CheckInstancesUpgradeAble.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID Note: This field may return null, indicating that no valid values can be obtained. |
| Reason | String | Reason Note: This field may return null, indicating that no valid values can be 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. |
| RuntimeVersion | String | RuntimeVersion |
| RuntimeLatestVersion | String | RuntimeLatestVersion |
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.) |
Version Info
Used by actions: DescribeVersions.
| Name | Type | Description |
|---|---|---|
| Name | String | Version name Note: this field may return null, indicating that no valid values can be obtained. |
| Version | String | Version Info Note: this field may return null, indicating that no valid values can be obtained. |
| Remark | String | Remark Note: this field may return null, indicating that no valid values can be obtained. |
Virtual node
Used by actions: DescribeClusterVirtualNode.
| Name | Type | Description |
|---|---|---|
| Name | String | Virtual node name |
| SubnetId | String | Subnet of the virtual node |
| Phase | String | Virtual node status |
| CreatedTime | String | Creation time Note: This field may return null, indicating that no valid values can be obtained. |
Virtual node pool
Used by actions: DescribeClusterVirtualNodePools.
| Name | Type | Description |
|---|---|---|
| NodePoolId | String | Node pool ID |
| SubnetIds | Array of String | List of subnets Note: This field may return null, indicating that no valid values can be obtained. |
| Name | String | Node pool name |
| LifeState | String | Node pool lifecycle status |
| Labels | Array of Label | Virtual node labels Note: This field may return null, indicating that no valid values can be obtained. |
| Taints | Array of Taint | Virtual node taint Note: This field may return null, indicating that no valid values can be obtained. |
Super Node
Used by actions: CreateClusterVirtualNode, CreateClusterVirtualNodePool.
| Name | Type | Required | Description |
|---|---|---|---|
| DisplayName | String | Yes | Node display name |
| SubnetId | String | Yes | Subnet ID |
| Tags | Array of Tag | No | Tencent Cloud tags |
피드백