Call the CreateCluster API to create a Lingjun cluster - Platform For AI - Alibaba Cloud -

Creates a Lingjun AI Computing Service cluster.

Operation description

Closes a remote session.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eflo:CreateCluster

create

*Cluster

acs:eflo:{#regionId}:{#accountId}:cluster/*

eflo:ImageSource
eflo:ImageOwnerId

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterName	string	No	The cluster name.	Standard_Cluster
ClusterType	string	No	The cluster type. Valid values: Lite : Lite	Lite
ClusterDescription	string	No	The cluster description.	标准集群测试
NodeGroups	array<object>	No	The list of node groups.
	array<object>	No	The node group information.
SystemDisk	object	No	The system cloud disk information.
Category	string	No	The cloud disk type. Valid values: cloud_essd: Enterprise SSD (ESSD).	cloud_essd
Size	integer	No	The cloud disk size. Unit: GB.	9999
PerformanceLevel	string	No	Settings for the performance level (PL) when an ESSD is created as the system cloud disk. Valid values: PL0: a maximum of 10,000 random read/write IOPS per cloud disk. PL1: a maximum of 50,000 random read/write IOPS per cloud disk.	PL1
NodeGroupDescription	string	No	The node group description.	默认节点组
KeyPairName	string	No	The key pair name.	test-keypair
RamRoleName	string	No	The RAM role name of the node. You can call the RAM API ListRoles to query the node RAM roles that you have created. The trusted entity of the specified role must be set to Lingjun AI Computing Service. Note: Clearing an existing role is not supported.	xianwen-test-ram-role
FileSystemMountEnabled	boolean	No	Specifies whether file system mounting is supported.	false
NodeGroupName	string	No	The node group name.	emr-default
ZoneId	string	No	The zone ID.	cn-hangzhou-i
UserData	string	No	The custom executable shell script. The script must be Base64-encoded. The maximum size of the raw data is 16 KB.	ZWNobyBoZWxsbyBlY3Mh
VirtualGpuEnabled	boolean	No	Specifies whether to enable GPU splitting.	false
MachineType	string	No	The machine type.	efg1.nvga1
ImageId	string	No	The system image ID.	i190297201634099844192
Nodes	array<object>	No	The list of nodes.
	array<object>	No	The list of nodes.
DataDisk	array<object>	No	The data cloud disk specifications.
	object	No	The information about the data disk specifications.
DeleteWithNode	boolean	No	Specifies whether to delete the data disk when the node is released.	true
Category	string	No	The type.	cloud_essd
Size	integer	No	The disk size.	10
PerformanceLevel	string	No	The performance metric of the data disk.	PL0
BurstingEnabled	boolean	No	Specifies whether to enable performance burst.	false
ProvisionedIops	integer	No	The provisioned performance (IOPS). The value must be in the range of 0 to 50,000.	1000
VpcId	string	No	The VPC ID.	vpc-0jlasms92fdxqd3wlf8ny
VSwitchId	string	No	The vSwitch ID.	vsw-bp169pi5fj151rrms4sia
NodeId	string	No	The node ID.	e01poc-cn-i7m2wnivf0d
Hostname	string	No	The hostname.	8d13b784-17a9-11ed-bc7b-acde48001122
LoginPassword	string	No	The logon password.	***
HyperNodes	array<object>	No	The list of hyper nodes.
	array<object>	No	The hyper node information.
DataDisk	array<object>	No	The list of data cloud disks.
	object	No	The information about the data disk.
DeleteWithNode	boolean	No	Specifies whether to delete the data disk when the node is released.	true
Category	string	No	The disk type. Valid value: cloud_essd: ESSD.	cloud_essd
Size	integer	No	The disk size in GiB.	180
PerformanceLevel	string	No	The performance level of the ESSD that you create as a data disk. Valid values: PL0: A single disk delivers up to 10,000 random read/write IOPS. PL1: A single disk delivers up to 50,000 random read/write IOPS. PL2: A single disk delivers up to 100,000 random read/write IOPS. PL3: A single disk delivers up to 1,000,000 random read/write IOPS. Default value: PL1.	PL0
BurstingEnabled	boolean	No	Specifies whether to enable performance burst.	true
ProvisionedIops	integer	No	The provisioned read/write IOPS of the ESSD AutoPL disk.	10000
VpcId	string	No	The VPC ID.	vpc-uf689skpx56nk7yfw0jhy
VSwitchId	string	No	The vSwitch ID.	vsw-bp1xn9iq3s3p8218c4qu4
HyperNodeId	string	No	The hyper node ID.	e01-dw72u2c23jk
Hostname	string	No	The hostname.	q25b01265.cloud.ng152
LoginPassword	string	No	The logon password.	aaadddddfdsfdsfsdffd
LoginPassword	string	No	The logon password.	密码
IgnoreFailedNodeTasks	boolean	No	Specifies whether to skip failed nodes. Default value: False.	False
ResourceGroupId	string	No	The resource group ID. Valid values: rg-acfm26zesdlqa2q : rg-acfm26zesdlqa2q	rg-aek2xdkc6icwfha
Networks	object	No	The network information.
NewVpdInfo	object	No	The VPD configuration information.
CenId	string	No	The Cloud Enterprise Network (CEN) instance ID.	cen-1gb1eftc5qp2ao75fo
CloudLinkCidr	string	No	The cloud link CIDR block.	172.16.0.0/24
CloudLinkId	string	No	The cloud link ID.	vcc-cn-c4dtycm5i08
MonitorVpcId	string	No	The VPC ID.	vpc-0jl2x45apm6odc2c10h25
MonitorVswitchId	string	No	The vSwitch ID.	vsw-0jl2w3ffbghkss0x2foff
VpdCidr	string	No	The cluster CIDR block.	192.168.0.0/16
VpdSubnets	array<object>	No	The cluster subnets.
	object	No	The cluster subnets.
SubnetCidr	string	No	The CIDR block of the subnet.	10.0.1.8/24
ZoneId	string	No	The zone ID.	cn-wulanchabu-b
SubnetType	string	No	The subnet type.	10.0.2.8/24
VpdInfo	object	No	The information about the reused VPD.
VpdId	string	No	The VPC ID.	vpd-vfuz6ejv
VpdSubnets	array	No	The list of cluster subnet IDs.
	string	No	The cluster subnet ID.	subnet-jcloe1
IpAllocationPolicy	array<object>	No	The IP allocation policy.
	array<object>	No	The IP allocation policy.
MachineTypePolicy	array<object>	No	The machine type allocation policy.
	array<object>	No	The machine type allocation policy.
Bonds	array<object>	No	The bond information.
	object	No	The bond information.
Subnet	string	No	The source cluster subnet for the IP address.	192.168.1.0/24
Name	string	No	The bond name.	bond0
MachineType	string	No	The machine type.	efg1.nvga8n
BondPolicy	object	No	The bond policy.
Bonds	array<object>	No	The bond information.
	object	No	The bond information.
Subnet	string	No	The source cluster subnet for the IP address.	172.16.0.0/24
Name	string	No	The bond name.	bond0
BondDefaultSubnet	string	No	The default bond cluster subnet.	172.168.0.0/24
NodePolicy	array<object>	No	The node allocation policy.
	array<object>	No	The node allocation policy.
Bonds	array<object>	No	The bond information.
	object	No	The bond information.
Subnet	string	No	The source cluster subnet for the IP address.	10.0.0.0/24
Name	string	No	The bond name.	bond0
NodeId	string	No	The node ID.	e01-cn-2r42vq62001
SecurityGroupId	string	No	The security group ID.	sg-bp1d3dvbh9by7j5rujax
VSwitchZoneId	string	No	The zone ID of the vSwitch.	cn-shanghai-b
VpcId	string	No	The VPC ID.	vpc-0jl36lqzmc06qogy0t5ll
VSwitchId	string	No	The vSwitch ID.	vsw-asjdfklj
TailIpVersion	string	No	The IP version.	IPv4
Tag	array<object>	No	The resource tags.
	object	No	The tag list.
Value	string	No	The tag value.	dev
Key	string	No	The tag key.	env-name
Components	array<object>	No	The components (software instances).
	array<object>	No	The component type.
ComponentType	string	No	The component type. Valid values: ARMS : ARMS monitoring. ACKEdge : ACK edge cluster.	ACKEdge
ComponentConfig	object	No	The component configuration.
BasicArgs	any	No	The basic parameters of the component.	{ "EndpointPublicAccess": false, "ContainerCidr": "10.4.0.0/24", "KeyPair": "test", "NodeCidrMask": "25", "ResourceGroupId": "rg-axsadm3sdzsdvdsndstdisd", "WorkerSystemDiskCategory": "da", "WorkerSystemDiskSize": 40, "DeletionProtection": false, "KubeProxy": "iptables", "Name": "da", "LoadBalancerSpec": "slb.s1.small", "Runtime": { "Version": "19.03.15", "Name": "docker" }, "IsEnterpriseSecurityGroup": true, "Vpcid": "192.168.23.0/24", "NumOfNodes": 1, "VswitchIds": [ "dad" ], "ServiceCidr": "10.0.0.0/16", "SnatEntry": false, "kubernetesVersion": "1.20.11-aliyunedge.1", "WorkerInstanceTypes": [ "da" ] }
NodeUnits	array	No	The node pool configuration, which is used to establish the mapping between node groups and node pools. This parameter is required when ComponentType is set to ACKEdge. Leave this parameter empty for other component types.
	any	No	The node pool configuration, which is used to establish the mapping between node groups and node pools. This parameter is required when ComponentType is set to ACKEdge. Leave this parameter empty for other component types.	{ "Options": {}, "Type": "edge", "ResourceGroupId": "rg-acfm2cdxm3zvnt4dsa1s1t65fi", "RelatedNodeGroups": [ "tes" ], "NodeUnitKey": "da", "MaxNodes": 30 }
HpnZone	string	No	The cluster number. Valid values: A1 : A1	A1
NimizVSwitches	array	No	The node vSwitches.
	string	No	The node vSwitch ID.	vsw-0jlx7dkziyhgf6klwnsi3
OpenEniJumboFrame	boolean	No	Specifies whether the network interface supports jumbo frames.	false

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	3C683243-7915-57FB-9570-A2932C1C0F78
ClusterId	string	The cluster ID.	i116913051663373010974
TaskId	string	The task ID.	i159809891662373011015

Examples

Success response

JSON format

{
  "RequestId": "3C683243-7915-57FB-9570-A2932C1C0F78",
  "ClusterId": "i116913051663373010974",
  "TaskId": "i159809891662373011015"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.