Appendix

ClusterSpec

Parameter name	Types	Required or not	Description
clusterID	String	No	Cluster ID. This field is not required during cluster creation.
clusterName	String	Yes	Cluster name. The cluster name can only contain uppercase/lowercase letters, numbers, -, ., and _, not exceeding 65 characters and non-null.
clusterType	String	No	Cluster type, currently only supporting normal, defaulting to normal
description	String	No	Cluster description
k8sVersion	String	Yes	K8S version No., options [1.18.9, 1.20.8, 1.21.14, 1.22.5, 1.24.4, 1.26.9]
runtimeType	String	No	Container runtime type, options [docker, containerd, bci]. Default is docker for general clusters, and BCI for serverless clusters.
runtimeVersion	String	No	Container runtime version, currently only supporting 18.9.2, defaulting to 18.9.2
vpcID	String	Yes	VPC ID
vpcCIDR	String	No	VPC network segment. This value is not required during cluster creation.
vpcCIDRIPv6	String	No	VPC IPv6 network segment. This value is not required during cluster creation.
plugins	List<String>	No	Plugin list, supporting [ cce-ingress-controller, cluster-autoscaler, core-dns, core-dns-for-serverless, cronhpa, ip-masq-agent, kongming-nvidia, kube-proxy, kunlun-nvidia, metrics-adapter, metrics-server, network-inspector, nvidia-gpu, vpc-cni, vpc-route ]. Core-dns,, kube-proxy, and metrics-server are deployed in all clusters by default; when the container network mode is kubenet, ip-masq-agent is deployed by default; for shared GPU clusters, kongming-nvidia is deployed by default, or nvidia-gpu is deployed; vpc-route is deployed for CNI in VPC routing mode, while vpc-cni is deployed in VPC secondary IP mode;
masterConfig	MasterConfig	Yes	Master node configuration
containerNetworkConfig	ContainerNetworkConfig	Yes	Configure container network
k8sCustomConfig	K8SCustomConfig	No	K8S custom configuration
PluginsConfig	map[string]PluginHelmConfig	No	Plugin Helm installation configuration
ForbidDelete	bool	No	Cluster deletion protection identifier. True indicates enabling deletion protection and forbidding cluster deletion; False indicates disabling deletion protection and allowing cluster deletion.
ResourceChargingOption	ResourceChargingOption	No	IaaS resource payment options
AuthenticateMode	string	No	APIServer certification mode, options: x509, OIDC
Tags	List<Tag>	No	Tag

CreateClusterOptions

Parameter name	Types	Required or not	Description
skipNetworkCheck	Boolean	No	Whether to forcibly skip container network check

MasterConfig

Parameter name	Types	Required or not	Description
masterType	String	Yes	Master deployment type, creation options [managedPro, containerizedCustom, serverless]. Possible values returned by the API: [managed, managedPro, custom, containerizedCustom, serverless].
clusterHA	Integer	No	Master replicas, options [1, 3, 5, 2]. For managed clusters, options include [1, 3], defaulting to 3. For Serverless clusters, the value is only 2. This value is not required for custom clusters.
exposedPublic	Boolean	No	Whether to expose to the public network
clusterBLBVPCSubnetID	String	No	BLB VPC subnet ID of the Cluster. This value is not required for managed clusters, but must be set for custom clusters.
managedClusterMasterOption	ManagedClusterMasterOption	No	Managed cluster master node options, only required for managed clusters.
serverlessMasterOption	ServerlessMasterOption	No	Serverless master node options, only required for serverless clusters.

ManagedClusterMasterOption

Parameter name	Types	Required or not	Description
masterVPCSubnetZone	String	No	VPC subnet zone where the master resides, options: [zoneA, zoneB, zoneC, zoneD, zoneE, zoneF], defaulting to zoneA.
masterFlavor	String	No	Managed cluster specifications, options: [L50, L200, L500, L1000, L3000, L5000], defaulting to L50.
clusterBLBSource	String	No	BLB ownership of cluster Apiserver, defaulting to USER.

ServerlessMasterOption

Parameter name	Types	Required or not	Description
masterSecurityGroupID	String	No	Cluster master security group, automatically covered by the backend. Manual input is not required for users.
vkSecurityGroupID	String	Yes	Security group for BCI instances launched in cluster
vkSubnets	List<VKSubnetType>	No	List of subnets where BCI instances are launched in the cluster. If not provided, clusterBLBVPCSubnetID will be used.

ContainerNetworkConfig

Parameter name	Types	Required or not	Description
mode	String	Yes	Container network mode, options: [kubenet, vpc-cni, vpc-route-veth, vpc-route-ipvlan, vpc-route-auto-detect, vpc-secondary-ip-veth, vpc-secondary-ip-ipvlan, vpc-secondary-ip-auto-detect]
eniVPCSubnetIDs	Map<String,List>	No	ENI VPC subnet ID
eniSecurityGroupID	String	No	ENI security group ID
ipVersion	String	No	Container IP type, options: [IPv4, IPv6, dualStack], defaulting to IPv4
lbServiceVPCSubnetID	String	Yes	Associated BLB subnet ID
nodePortRangeMax	Integer	No	Specify the port range of NodePort Service, defaulting to 32767, maximum 65536
nodePortRangeMin	Integer	No	Specify the port range of NodePort Service, defaulting to 30000, maximum 65536
clusterPodCIDR	String	No	Cluster Pod IP network segment, valid in kubenet mode. VPC CIDR is automatically used when the network type is VPC-CNI.
clusterPodCIDRIPv6	String	No	Cluster Pod IPv6 network segment, valid in kubenet mode. VPC CIDR is automatically used when the network type is VPC-CNI.
clusterIPServiceCIDR	String	No	Service ClusterIP network segment, set for IPv4
clusterIPServiceCIDRIPv6	String	No	Service ClusterIPv6 network segment, set for IPv6
maxPodsPerNode	Integer	No	Maximum number of pods per node, defaulting to 128
kubeProxyMode	String	No	kube-proxy mode, options: [IPVS, iptables], defaulting to IPVS

K8SCustomConfig

Parameter name	Types	Required or not	Description
masterFeatureGates	Map<String,Boolean>	No	Custom MasterFeatureGates
nodeFeatureGates	Map<String,Boolean>	No	Customize NodeFeatureGates
admissionPlugins	List	No	Custom AdmissionPlugins
pauseImage	String	No	Custom PauseImage
kubeAPIQPS	Integer	No	Custom KubeAPIQPS
kubeAPIBurst	Integer	No	Custom KubeAPIBurst
schedulerPredicates	List	No	Custom SchedulerPredicates
schedulerPriorities	Map<String,Integer>	No	Customize SchedulerPrioritiess
etcdDataPath	String	No	Custom etcd data directory

InstanceSet

Parameter name	Types	Required or not	Description
instanceSpec	InstanceSpec	Yes	Node configuration information
count	Integer	No	Nodes with above configurations, not required for existing nodes

InstanceSpec

Parameter name	Types	Required or not	Description
cceInstanceID	String	No	Unique identifier Instance for CCE. If unspecified by the user: CCE is automatically generated; if specified by the user: CCE is generated according to rules.
instanceName	String	No	Node name
runtimeType	String	No	Container runtime type, options [docker, bci]. Default is docker for general clusters, and BCI for serverless clusters.
runtimeVersion	String	No	Container runtime version, currently only supporting 18.9.2, defaulting to 18.9.2
clusterID	String	No	Cluster ID, not required during cluster creation
clusterRole	String	No	Role of node in the cluster, options [master, node], not required during cluster creation.
instanceGroupID	String	No	ID of node group where the nodes are located
instanceGroupName	String	No	Name of node group where the nodes are located
masterType	String	No	Master machine source. Options: [managedPro, containerizedCustom, serverless]. Possible values returned by the API: [managed, managedPro, custom, containerizedCustom, serverless].
existed	Boolean	No	Whether it is an existing node, required only when the node type is existing node
existedOption	ExistedOption	No	Existing instance-related configuration, required only when the node type is existing node.
machineType	String	No	Machine type, options [BCC, BBC, Metal, BCI]. Users do not need to set this value. It is set to BCI automatically for serverless, set to BCC automatically for managed cluster master, set to BCC automatically for new nodes, and set to BCC or BBC automatically for the existing nodes based on the node type.
instanceType	String	No	Machine specification, options: [N1, N2, N3, N4, N5, C1, C2, S1, G1, F1, ServerlessMaster]. For details, refer to Specifications, required only for custom new nodes. It is automatically set to ServerlessMaster for serverless cluster masters, configured with DefaultMasterConfig for managed cluster masters, and set based on the node type for the existing nodes.
deploySetID	String	No	Deployment group ID
autoSnapshotID	String	No	Automatic snapshot policy ID
bbcOption	BBCOption	No	BBC options, required only for the existing nodes of BBC type
vpcConfig	VPCConfig	No	VPC options, required when creating BCC nodes and serverless masters. Managed master node group automatically uses Master Config configurations. The existing nodes automatically use their own VPC configurations.
instanceResource	InstanceResource	No	Cluster specification-related configurations, required when creating BCC nodes. Managed master node group automatically uses backend default configurations. The existing nodes automatically use their own resource configurations.
imageID	String	No	When OS reinstallation is required for new BCC nodes and existing nodes, either imageID or InstanceOS must be set. ImageID takes precedence. If InstanceOS information is provided by the user, ImageID will be calculated by the backend.
instanceOS	InstanceOS	No	When OS reinstallation is required for new BCC nodes and existing nodes, either imageID or InstanceOS must be set. ImageID takes precedence. If InstanceOS information is provided by the user, ImageID will be calculated by the backend.
needEIP	Boolean	No	Whether EIP is required for machine
relationTag	Boolean	No	Whether to apply the node tags to other resources bound to the node, e.g., CDS, defaulting to false
userData	String	No	Node custom data supports driver installation. Since the UserData set is not encrypted when transmitting API requests, it is advised not to include sensitive information, such as passwords or private keys, in plaintext. If such information must be specified, it is recommended to encrypt it and encode it using Base64 before including it. The data should then be decrypted in the same manner within the node.
eipOption	EIPOption	No	EIP options, required when needEIP is True.
adminPassword	String	No	Administrator password. If not set, it will be automatically generated by the system. Existing BCC nodes must set this when not reinstalling OS. Password must be 8-32 characters, including letters, numbers, and symbols (limited to !@#$%^*())
sshKeyID	String	No	SSH Key ID
instanceChargingType	String	No	Node charge type, options: [Prepaid, Postpaid, bidding]. It is defaulted for new nodes, managed cluster master nodes, and serverless nodes, only limited to Postpaid. Existing nodes support Prepaid or Postpaid.
instancePreChargingOption	InstancePreChargingOption	No	Node prepay option, required for prepaid nodes.
deleteOption	DeleteOption	No	Delete node options.
deployCustomConfig	DeployCustomConfig	No	Custom deployment options
tags	List<Tag>	No	Node tag list.
labels	Map<String,String>	No	Node label list. The backend automatically adds two labels: cluster-id and cluster-role.
taints	List<Taint>	No	Node taint list
annotations	Map<String,String>	No	Node annotation list
bid	Boolean	No	Whether to activate spot, defaulting to false
bidOption	BidOption	No	Spot instance option, required when bid=true
isOpenHostnameDomain	Boolean	No	Whether to automatically generate hostname domain
ehcClusterId	String	No	EHC cluster ID

ExistedOption

Parameter name	Types	Required or not	Description
existedInstanceID	String	Yes	Existing node ID
rebuild	Boolean	No	Whether to reinstall OS, defaulting to true, namely reinstalling OS

BBCOption

Parameter name	Types	Required or not	Description
reserveData	Boolean	Yes	Whether to preserve data
raidID	String	No	Disk array type ID; required when reserveData=false, and invalid when reserveData=true
sysDiskSize	Integer	No	System disk partition size in GB; required when reserveData=false, and invalid when reserveData=true
flavor	String	No	Package ID, e.g.: BBC-G4-02S
diskInfo	String	No	Disk array type, such as Raid5. For BBCs that do not support RAID, set this to NoRaid.

VPCConfig

Parameter name	Types	Required or not	Description
vpcID	String	No	VPC ID. Use the cluster VPC ID if null
vpcSubnetID	String	No	VPC subnet ID, required for new nodes, but not required for existing nodes.
securityGroupID	String	Yes	Security group ID, required for new nodes if securityGroup is not set, but not required for existing nodes.
securityGroupType	String	No	Security group type, options [normal，enterprise], defaulting to normal
securityGroup	SecurityGroup	No	Security group information, recommended settings for new BCC, but not required for existing nodes.
vpcSubnetType	String	No	VPC subnet type, options [BBC, BCC], not required during cluster creation, but automatically configured by backend based on subnet ID.
vpcSubnetCIDR	String	No	VPC subnet segment, not required during cluster creation, but automatically configured by backend based on subnet ID.
vpcSubnetCIDRIPv6	String	No	VPC IPv6 subnet segment, not required during cluster creation, but automatically configured by backend based on subnet ID.
availableZone	String	No	Availability zone, options [zoneA, zoneB, zoneC, zoneD, zoneE, zoneF], not required during cluster creation, but automatically configured by backend based on subnet ID.

SecurityGroup

Parameter name	Types	Required or not	Description
customSecurityGroups	String array	No	User-specified security group to be bound to nodes
enableCCERequiredSecurityGroup	bool	No	Whether to bind CCE default security group to nodes
enableCCEOptionalSecurityGroup	bool	No	Whether to bind CCE optional security group to nodes

InstanceResource

Parameter name	Types	Required or not	Description
cpu	Integer	No	CPU core count. This field is mandatory for new nodes.
mem	Integer	No	Memory size in GB. This field is mandatory for new nodes.
rootDiskType	String	No	Root disk type, options [hp1, cloud_hp1, hdd, local, sata, ssd], defaulting to hp1 for new nodes. The settings for existing nodes are consistent with their original attributes. For more details, refer to: CDS Performance and CDS Type Parameters
rootDiskSize	Integer	No	Root disk size in GB, defaulting to 40
localDiskSize	Integer	No	Local disk size, mandatory for GPU machine, in GB
cdsList	List<CDSConfig>	No	CDS list, with the first disk defaulting to docker and kubelet data disk
gpuType	String	No	GPU type, options [V100-32, V100-16, P40, P4, K40, DLCard]. For details, refer to: GPU Card Details, mandatory when the node type is G1
gpuCount	Integer	No	GPU count, mandatory when the node type is G1
machineSpec	String	Yes	Machine specifications, mandatory parameter
cpuThreadConfig	String	No	Adjust the count of threads per physical core (vCPU), essentially corresponding to whether the hyper-threading capability of each processor is enabled. Value range: 1, 2 Note: 1. By default, it is default to 2 for Baidu AI Cloud’s instances. 2. Only EBC instance with Intel 7th generation or above and AMD 3rd generation or above supports setting the CPU thread count. 3. This parameter cannot be modified after instance creation.
numaConfig	String	No	Adjust the NUMA configuration of the CPU, with different meanings for values depending on the processor platform. 1. Intel platform: 0 represents disabling NUMA features, 1 represents enabling NUMA features. 2. AMD platform: mainly affect the NPS (Nodes Per Socket) configuration; possible values are 0, 1, 2, 4, auto, corresponding to NPS0, NPS1, NPS2, NPS4 and automatic, respectively. Note: 1. By default, Baidu AI Cloud’s instances are configured with NUMA optimization enabled (Intel instances) or NPS1 (AMD instances), i.e., a default of 1. 2. Only EBC instance with Intel 7th generation or above and AMD 3rd generation or above supports setting NUMA option. 3. This parameter cannot be modified after instance creation.

CDSConfig

Parameter name	Types	Required or not	Description
diskPath	String	Yes	Disk path
storageType	String	Yes	Storage class, options [hp1, cloud_hp1, hdd, local, sata, ssd]. For more details, refer to: CDS Performance and CDS Type Parameters
cdsSize	Integer	Yes	Disk space
snapshotID	String	No	Snapshot ID: Supports creating a disk from a snapshot

InstanceOS

Parameter name	Types	Required or not	Description
imageType	String	Yes	Image type. Values include [All, System, Custom, Integration, Sharing, GpuBccSystem, GpuBccCustom, BbcSystem, BbcCustom]
imageName	String	Yes	Image name, for example: ubuntu-14.04.1-server-amd64-201506171832.
osType	String	Yes	OS type, options [linux, windows]
osName	String	Yes	OS name, options [CentOS, Ubuntu, Windows Server, Debian, opensuse]
osVersion	String	Yes	OS version, e.g., 14.04.1 LTS
osArch	String	Yes	OS architecture, for example: x86_64 (64-bit).
osBuild	String	No	Image creation time information, e.g., 2015061700

EIPOption

Parameter name	Types	Required or not	Description
eipName	String	Yes	EIP name
eipChargeType	String	Yes	EIP charge type, options [ByTraffic, ByBandwidth]
eipPurchaseType	String	No	EIP internet connection type, options [BGP (standard BGP), BGP_S (enhanced BGP), ChinaTelcom, ChinaUnicom, ChinaMobile], defaulting to standard BGP.
eipBandwidth	Integer	Yes	EIP bandwidth. Range is 1-200 for pay-by-bandwidth, and 1-1000 for pay-as-you-go traffic

InstancePreChargingOption

Parameter name	Types	Required or not	Description
purchaseTime	Integer	Yes	Purchase time
purchaseTimeUnit	String	Yes	Purchase time unit
autoRenew	Boolean	Yes	Yes
autoRenewTimeUnit	String	Yes	Renewal unit
autoRenewTime	Integer	Yes	Renewal time

DeleteOption

Parameter name	Types	Required or not	Description
moveOut	Boolean	No	Indicates whether to remove the node. "True" means the node will only be removed from the cluster, whereas "False" means the node will be deleted. New nodes default to "False" during cluster creation, while existing nodes default to "True" when being added.
deleteResource	Boolean	No	Indicates whether to delete related resources. New nodes default to "True" during cluster creation, and existing nodes default to "False" when being added.
deleteCDSSnapshot	Boolean	No	Indicates whether to delete the CDS snapshot. New nodes default to "True" during cluster creation, and existing nodes default to "False" when being added.
drainNode	Boolean	No	Indicates whether to drain the node.

DeployCustomConfig

Parameter name	Types	Required or not	Description
dockerConfig	List<DockerConfig>	No	Docker-related configuration
containerdConfig	List<ContainerdConfig>	No	Containerd-related configuration
kubeletRootDir	String	No	Kubelet data directory
registryPullQPS	Integer	No	Limit for the number of image registry pull operations per second. This value must be a non-negative integer, with "0" meaning no limit.
registryBurst	Integer	No	Burst limit for image pulls, allowing temporary surges up to the specified count as long as it does not exceed the constraints set by registryPullQPS. This value must be a non-negative integer and is only applicable if registryPullQPS is greater than 0.
podPidsLimit	Integer	No	Maximum number of PIDs available per pod
eventRecordQPS	Integer	No	Maximum number of events that can be created per second. This value must be a non-negative integer, with "0" meaning no limit.
eventBurst	Integer	No	Burst limit for event creation, allowing temporary surges up to the specified count as long as it does not exceed the constraints set by eventRecordQPS. This value must be a non-negative integer and is only applicable if eventRecordQPS is greater than 0.
kubeAPIQPS	Integer	No	QPS limit (queries per second) when communicating with the Kubernetes API server
kubeAPIBurst	Integer	No	Burst traffic limit when communicating with Kubernetes API server. This value must be a non-negative integer.
maxPods	Integer	No	Maximum number of pods that can run on the kubelet of a node. This value must be a non-negative integer.
cpuManagerPolicy	string	No	Name of the cpuManagerPolicy strategy to be used, options [none, static], defaulting to none
topologyManagerScope	string	No	Topology manager action scope, options [pod, container], defaulting to container
topologyManagerPolicy	string	No	Topology manager policy name, options [none, best-effort, restricted, single-numa-node], defaulting to none
cpuCFSQuota	Boolean	No	Whether to impose CPU CFS quota constraints for containers with CPU limits
postUserScriptFailedAutoCordon	Boolean	No	Whether to automatically block node upon script execution failure during deployment
kubeletBindAddressType	string	No	Kubelet binding address type, options [all, local, hostip], defaulting to hostip
EnableResourceReserved	Boolean	No	Whether to enable resource reservation
kubeReserved	Map<String,String>	No	Resource reservation quota, e.g., {cpu: 100m, memory: 1000Mi}
enableCordon	Boolean	No	Whether to block the node
preUserScript	String	No	Pre-deployment execution script, passed as base64-encoded parameter by frontend
postUserScript	String	No	Post-deployment execution script, passed as base64-encoded parameter by frontend

DockerConfig

Parameter name	Types	Required or not	Description
dockerDataRoot	String	No	Custom docker data directory
registryMirrors	List	No	Custom RegistryMirrors
insecureRegistries	List	No	Custom InsecureRegistries
dockerLogMaxSize	String	No	Docker log size, defaulting to 20 m
dockerLogMaxFile	String	No	Docker log retention count, defaulting to 10
dockerBIP	String	No	Docker0 bridge network segment, defaulting to 169.254.30.1/28

ContainerdConfig

Parameter name	Types	Required or not	Description
dataRoot	String	No	Custom containerd data directory
registryMirrors	List	No	Custom RegistryMirrors
insecureRegistries	List	No	Custom InsecureRegistries

Tag

Parameter name	Types	Required or not	Description
tagKey	String	Yes	Tag Key
tagValue	String	Yes	Tag Value

Taint

Parameter name	Types	Required or not	Description
effect	String	Yes	Behavior when pod does not tolerate taint, options [NoSchedule, PreferNoSchedule, NoExecute]
key	String	Yes	Taint Key
timeAdded	Date-time	No	Time point of adding taints, used only when effect is NoExecute
value	String	Yes	Taint Value

BidOption

Parameter name	Types	Required or not	Description
bidMode	String	Yes	Spot mode, options: MARKET_PRICE_BID (bidding at market price), (proactive bidding by the user)
bidPrice	String	No	Spot instance bid, required when bidMode=MARKET_PRICE_BID
bidTimeout	Integer	Yes	Spot timeout (in minutes). If bidding is unsuccessful beyond this duration, the order will be automatically canceled and the instance will be cleared
bidReleaseEIP	Boolean	No	Enable EIP cascading deletion or not when a spot instance is preempted and deleted, defaulting to false
bidReleaseCDS	Boolean	No	Enable CDS cascading deletion or not when a spot instance is preempted and deleted, defaulting to false

ClusterPage

Parameter name	Types	Description
keywordType	String	Cluster fuzzy query fields, options [clusterName, clusterID]
keyword	String	Query keyword
orderBy	String	Cluster query sorting fields, options: [clusterName, clusterID, createdAt]
order	String	Sorting method, options [ASC, DESC]
pageNo	Integer	Page No.
pageSize	Integer	Results per page
totalCount	Integer	Total clusters
clusterList	List<Cluster>	Queried cluster list

Cluster

Parameter name	Types	Description
spec	ClusterSpec	Cluster attributes
status	ClusterStatus	Cluster status
createdAt	String	Creation time
updatedAt	String	Update time

ClusterStatus

Parameter name	Types	Description
clusterBLB	BLB	Cluster BLB
clusterPhase	String	Cluster status, options [pending, provisioning, provisioned, running, create_failed, deleting, deleted, delete_failed]
nodeNum	Integer	Node count

BLB

Parameter name	Types	Description
id	String	BLB ID
vpcIP	String	VPC IP address
eip	String	EIP address

VKSubnetType

Parameter name	Types	Required or not	Description
availableZone	String	Yes	Availability zone name
subnetID	String	Yes	Subnet ID

InstancePage

Parameter name	Types	Description
clusterID	String	Cluster ID
keywordType	String	Cluster fuzzy query fields, options [clusterName, clusterID]
keyword	String	Query keyword
orderBy	String	Cluster query sorting fields, options: [clusterName, clusterID, createdAt]
order	String	Sorting method, options [ASC, DESC]
pageNo	Integer	Page No.
pageSize	Integer	Results per page
totalCount	Integer	Total nodes
instanceList	List<Instance>	Node list

Instance

Parameter name	Types	Description
createdAt	String	Node creation time
spec	InstanceSpec	Node configuration
status	InstanceStatus	Node status
updatedAt	String	Node update time

InstanceStatus

Parameter name	Types	Description
instancePhase	String	Node status, options [pending, provisioning, provisioned, running, create_failed, deleting, deleted, delete_failed]. Pending, provisioning, and provisioned indicate the Creating status.
machine	Machine	Virtual machine information
machineStatus	String	BBC virtual machine status, options [ACTIVE, BUILD, REBUILD, DELETED, SNAPSHOT, DELETE_SNAPSHOT, VOLUME_RESIZE, ERROR, EXPIRED, REBOOT, RECHARGE, SHUTOFF, STOPPED, UNKNOWN]

Machine

Parameter name	Types	Description
eip	String	EIP IP address
instanceID	String	Corresponding node ID
instanceName	String	Corresponding node name
mountList	List<MountConfig>	Disk attachment information list
orderID	String	Order ID
vpcIP	String	VPC IP address
vpcIPIPv6	String	VPC IPv6 address
k8sNodeName	String	K8S NodeName, with IP or Hostname

MountConfig

Parameter name	Types	Description
cdsID	String	CDS ID
cdsSize	Integer	CDS size
device	String	Device path, e.g., /dev/vdb
diskPath	String	Disk path, e.g., /data
storageType	String	Disk storage class, options [hp1, cloud_hp1, hdd, local, sata, ssd]. For more details, refer to: CDS Performance and CDS Type Parameters

ListInstancesByInstanceGroupIDPage

Parameter name	Types	Description
pageNo	Integer	Page No.
pageSize	Integer	Results per page
totalCount	Integer	Total nodes
list	List<Instance>	Node list

InstanceGroup

Parameter name	Types	Description
spec	InstanceGroupSpec	Configuration of node group
status	InstanceGroupStatus	Status of node group
createdAt	String	Node group creation time

InstanceGroupSpec

Parameter name	Types	Description
cceInstanceGroupID	String	Node group ID
instanceGroupName	String	Name of node group
clusterID	String	Cluster ID
clusterRole	String	Role of node in the cluster. Currently, the node group only supports nod, defaulting to node
shrinkPolicy	String	Node group shrinking rules. Options: [Priority, Priority]..
updatePolicy	String	Node group update rule. Options: [Rolling, Concurrency].
cleanPolicy	String	Node cleaning rules, options [Remain, Delete].
instanceTemplate	InstanceTemplate	Node configuration
replicas	Integer	Node replica count
clusterAutoscalerSpec	ClusterAutoscalerSpec	Cluster Autoscaler configuration

InstanceTemplate

This structure is equivalent to InstanceSpec. See InstanceSpec

ClusterAutoscalerSpec

Parameter name	Types	Description
enabled	Boolean	Whether to enable Autoscaler
minReplicas	Integer	Minimum number of replicas. The range of values is a set of natural numbers.
maxReplicas	Integer	Maximum number of replicas. The range of values is a set of natural numbers, but must be greater than minReplicas.
scalingGroupPriority	Integer	Scaling group priority. The range of values is a set of natural numbers.

InstanceGroupStatus

Parameter name	Types	Description
readyReplicas	Integer	Number of nodes in Ready state in the node group
pause	Pause	Node group pause status

Pause

Parameter name	Types	Description
paused	Boolean	Whether the node group is in pause status
reason	String	Reason of node group in pause status

ListInstanceGroupPage

Parameter name	Types	Description
pageNo	Integer	Page No.
pageSize	Integer	Results per page
totalCount	Integer	Total number of node group
list	List<InstanceGroup>	Node group list

Autoscaler

Parameter name	Types	Description
clusterID	String	Cluster ID
clusterName	String	Cluster name
caConfig	ClusterAutoscalerConfig	Node group list

ClusterAutoscalerConfig

Parameter name	Types	Description
expander	String	Auto scaling group selection strategy. Options: [random, most-pods, least-waste, priority], defaulting to random.
instanceGroups	List<ClusterAutoscalerInstanceGroup>	Autoscaler configuration in the node group. Users need not input this content.
kubeVersion	String	K8S version. When null, the backend automatically queries the cluster K8S version No.
maxEmptyBulkDelete	Integer	Maximum concurrent scale-down count
replicaCount	Integer	Expected replica count
scaleDownDelayAfterAdd	Integer	Scale-down start latency after scale-up, in minutes
scaleDownEnabled	Boolean	Start scale-down, defaulting to false
scaleDownGPUUtilizationThreshold	Integer	GPU scale-down threshold percentage, value range (0, 100).
scaleDownUnneededTime	Integer	Scale-down trigger latency, in minutes.
scaleDownUtilizationThreshold	Integer	Scale-down threshold percentage, value range (0, 100).
skipNodesWithLocalStorage	Boolean	Whether to skip the nodes stored locally, defaulting to true.
skipNodesWithSystemPods	Boolean	Whether to skip the nodes with system pods deployed, defaulting to true.

ClusterAutoscalerInstanceGroup

Parameter name	Types	Description
instanceGroupID	String	Node group ID
minReplicas	String	Minimum number of replicas
maxReplicas	String	Maximum number of replicas
priority	String	Priority

ContainerCIDRConflict

Parameter name	Types	Description
conflictCluster	ConflictCluster	Clusters in VPC conflicting with the container network segment, only applicable when NetworkConflictType is ContainerCIDRAndExistedClusterContainerCIDRConflict and not nil
conflictNodeCIDR	ConflictNodeCIDR	Node network segment conflicting with the container network segment, only applicable when NetworkConflictType is ContainerCIDRAndNodeCIDRConflict and not nil
conflictType	String	Network conflict types, options: [ContainerCIDRAndNodeCIDR, ContainerCIDRAndExistedClusterContainerCIDR, ContainerCIDRAndVPCRoute, ClusterIPCIDRAndNodeCIDR, ClusterIPCIDRAndContainerCIDR]
conflictVPCRoute	ConflictVPCRoute	VPC routing conflicting with the container network segment, only applicable when NetworkConflictType is ContainerCIDRAndVPCRouteConflict and not nil

ClusterIPCIDRConflict

Parameter name	Types	Description
conflictContainerCIDR	ConflictContainerCIDR	Container network segment conflict information
conflictNodeCIDR	ConflictNodeCIDR	Node network segment conflict information
conflictType	String	Network conflict types, options: [ContainerCIDRAndNodeCIDR, ContainerCIDRAndExistedClusterContainerCIDR, ContainerCIDRAndVPCRoute, ClusterIPCIDRAndNodeCIDR, ClusterIPCIDRAndContainerCIDR]

ConflictCluster

Parameter name	Types	Description
clusterID	String	Cluster ID
containerCIDR	String	Conflicting container network segment

ConflictContainerCIDR

Parameter name	Types	Description
containerCIDR	String	Conflicting container network segment

ConflictNodeCIDR

Parameter name	Types	Description
nodeCIDR	String	Conflicting node network segment

ConflictVPCRoute

Parameter name	Types	Description
routeRule	RouteRule	Conflicting VPC route

RouteRule

Parameter name	Types	Description
routeRuleId	String	Routing rule ID
routeTableId	String	Route table ID
sourceAddress	String	Source address
destinationAddress	String	Destination address
nexthopId	String	Next hop ID
nexthopType	String	Next hop type
description	String	Description

ListTaskPage

Parameter name	Types	Description
pageNo	Integer	Page No.
pageSize	Integer	Results per page
totalCount	Integer	Total count of tasks
items	List<Task>	Task list

Task

Parameter name	Types	Description
id	String	Task ID
type	String	Task type
description	String	Task description
startTime	String	Task start time
finishTime	String	Task end time
phase	String	Task phase, possible options [Pending, Processing, Done, Aborted, Collecting]
processes	List<TaskProcess>	Task progress list
errMessage	String	Task error message

TaskProcess

Parameter name	Types	Description
name	String	Task progress name
phase	String	Task progress phase, possible options [Pending, Processing, Done, Aborted]
startTime	String	Task progress start time
finishTime	String	Task progress end time
metrics	Map<String, String>	Task progress collection items, varying with task type
subProcesses	List<TaskProcess>	Sub-progress list of task progress
errMessage	String	Error message

Step

Parameter name	Types	Description
stepName	String	Step name
stepStatus	String	Step status, options [todo, doing, paused, done, failed]
ready	Boolean	Ready or not
startTime	String	Step start time
finishedTime	String	Step end time
costSeconds	integer	Step duration
retryCount	integer	Retry count
errorInfo	ReconcileResponse	Failure details

ReconcileResponse

Parameter name	Types	Description
code	string	Response codes
message	String	Response information
traceID	String	Request ID. This ID is provided for issue localization.
suggestion	integer	Suggestion information

AddOnInfo

Parameter name	Types	Description
meta	Meta	Basic information of components
instance	AddOnInstance	Information about component installation. If the component is not installed, this field will be null.
multiInstances	List<AddOnInstance>	If the component supports multi-instance deployment, all instances of that component will be deployed. Typically, this field is not used.

Meta

Parameter name	Types	Description
name	String	Component name
type	String	Type of component. Includes CloudNativeAI, Networking, HybridSchedule, Image, Storage, and Observability.
latestVersion	String	Latest component version
shortIntroduction	String	Introduction to component
defaultParams	String	Default component deployment parameters
installInfo	InstallInfo	Whether components can be installed

AddOnInstance

Parameter name	Types	Description
name	String	Component name
installedVersion	String	Installed component version
params	String	Component deployment parameters
status	AddonInstanceStatus	Component status
uninstallInfo	UninstallInfo	Whether components can be uninstalled
upgradeInfo	UpgradeInfo	Whether components can be upgraded
updateInfo	UpdateInfo	Whether the component deployment parameters can be updated

AddonInstanceStatus

Parameter name	Types	Description
phase	String	Current component status
code	String	Error code content when the component status is abnormal
message	String	Error details when the component status is abnormal
traceID	String	Fault ID when the component status is abnormal

InstallInfo

Parameter name	Types	Description
allowInstall	String	Whether the component installation is allowed
message	String	If installation is not allowed, this field is filled with reasons

UninstallInfo

Parameter name	Types	Description
allowUninstall	String	Whether components can be uninstalled
message	String	If download is not allowed, this field is filled with reasons

UpgradeInfo

Parameter name	Types	Description
allowUpgrade	String	Whether components can be upgraded
nextVersion	String	If upgrade is allowed, its target version
message	String	If upgrade is not allowed, this field is filled with reasons

ResourceChargingOption

Parameter name	Types	Description
ChargingType	String	Postpay or prepay
PurchaseTime	int	Prepay is valid: in month, 12 = 12 months
PurchaseTimeUnit	String	Prepay time unit
AutoRenew	bool	Whether to enable auto-renewal
AutoRenewTime	String	Auto-renewal duration: 12 = 12 months
AutoRenewTimeUnit	String	Renewal unit: month

PluginHelmConfig

Parameter name	Types	Description
PluginType	String	Plugin type (plugin name), optional
PluginName	String	Plugin alias, optional
ChartVersion	String	Version of chart used, optional
ChartName	string	ChartName of plugin in the cloud, optional
Namespaces	String	Namespace for plugin deployment, optional
Description	String	Description, optional
Values	String	Depend on plugin. The system plugin can pass a null value.

MachineSpecStatus

Parameter name	Types	Description
machineSpec	String	Specification package
status	String	Package status: Adapted, Unadapted, NotSupported

ExistedInstanceInCluster

Parameter name	Types	Description
existedInstanceID	String	BCC instance ID