CreateCluster-Intelligent Computing LINGJUN(LINGJUN)-阿里云帮助中心

Creates a Lingjun 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 name of the cluster.	Standard_Cluster
ClusterType	string	No	The type of the cluster. Valid values: Lite : Lite	Lite
ClusterDescription	string	No	The description of the cluster.	Standard cluster test
NodeGroups	array<object>	No	The node groups.
	array<object>	No	The node group information.
FileSystemMountEnabled	boolean	No	Specifies whether file system mounting is supported.	false
HyperNodes	array<object>	No	The hypernodes.
	array<object>	No	The hypernode information.
DataDisk	array<object>	No	The data cloud disks.
	object	No	The data cloud disk information.
BurstingEnabled	boolean	No	Specifies whether performance burst is enabled.	true
Category	string	No	The cloud disk category. Valid values: cloud_essd: ESSD.	cloud_essd
DeleteWithNode	boolean	No	Specifies whether the data cloud disk is released when the node is unsubscribed.	true
Device	string	No	The device name of the data cloud disk. This parameter applies only to full image scenarios. You can use this parameter to set the device name of the data cloud disk to match the source data cloud disk in the full image and modify the attributes of the corresponding data cloud disk. For scaling that does not use a full image, the Device parameter is configured by the system by default. When you use a full image for scaling, take note of the following items: Regardless of whether the data cloud disk parameters are explicitly specified, the system restores the data cloud disks from the source image. The content of the restored disks is identical to that of the source image data cloud disks. If data cloud disks are explicitly specified but the Device parameter is not set, additional empty data cloud disks are created. The quantity and attributes of these disks are determined by the specified data cloud disk parameters. If the Device parameter is explicitly specified for a data cloud disk but does not match the Device of any source image data cloud disk, additional empty data cloud disks are created. The quantity and attributes of these disks are determined by the specified data cloud disk parameters. If multiple data cloud disks and their Device parameters are explicitly specified, but all Device parameters point to the same source image data cloud disk, only one of the specified data cloud disks matches and overwrites the source image data cloud disk. The other specified data cloud disks are silently discarded, and no additional empty data cloud disks are created. If the Device parameter is explicitly specified and matches the Device of a source image data cloud disk, no additional empty data cloud disks are created. The specified data cloud disks map one-to-one with the source image data cloud disks based on the Device parameter. If the specified Size of a data cloud disk is smaller than the Size of the corresponding source image data cloud disk, the system returns HTTP status code 417 and the following error message: Data disk Size can not be less than the image data disk snapshot size for Device '/dev/xvdb'. Total number of data cloud disks (explicitly specified to be mounted on the node + restored from the image): up to 16 for standard cloud disk groups, and up to 4 when Cloud Paralleled File System (CPFS) is enabled.	/dev/xvdb
PerformanceLevel	string	No	The performance level of the ESSD used as a data cloud 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
ProvisionedIops	integer	No	The provisioned read and write IOPS for a single ESSD AutoPL cloud disk.	10000
Size	integer	No	The size of the cloud disk. Unit: GiB.	180
Hostname	string	No	The hostname.	q25b01265.cloud.ng152
HyperNodeId	string	No	The hypernode ID.	e01-dw72u2c23jk
LoginPassword	string	No	The logon password.	aaadddddfdsfdsfsdffd
VSwitchId	string	No	The vSwitch ID in the VPC.	vsw-bp1xn9iq3s3p8218c4qu4
VpcId	string	No	The VPC ID.	vpc-uf689skpx56nk7yfw0jhy
ImageId	string	No	The system image ID.	i190297201634099844192
KeyPairName	string	No	The name of the key pair.	test-keypair
LoginPassword	string	No	The logon password.	Password
MachineType	string	No	The machine type.	efg1.nvga1
NodeGroupDescription	string	No	The node group description.	Default node group
NodeGroupName	string	No	The node group name.	emr-default
Nodes	array<object>	No	The nodes.
	array<object>	No	The nodes.
DataDisk	array<object>	No	The data cloud disk specifications.
	object	No	The data cloud disk specification information.
BurstingEnabled	boolean	No	Specifies whether performance burst is enabled.	false
Category	string	No	The type.	cloud_essd
DeleteWithNode	boolean	No	Specifies whether the data cloud disk is released when the node is unsubscribed.	true
Device	string	No	The device name of the data cloud disk. This parameter applies only to full image scenarios. You can use this parameter to set the device name of the data cloud disk to match the source data cloud disk in the full image and modify the attributes of the corresponding data cloud disk. For scaling that does not use a full image, the Device parameter is configured by the system by default. When you use a full image for scaling, take note of the following items: Regardless of whether the data cloud disk parameters are explicitly specified, the system restores the data cloud disks from the source image. The content of the restored disks is identical to that of the source image data cloud disks. If data cloud disks are explicitly specified but the Device parameter is not set, additional empty data cloud disks are created. The quantity and attributes of these disks are determined by the specified data cloud disk parameters. If the Device parameter is explicitly specified for a data cloud disk but does not match the Device of any source image data cloud disk, additional empty data cloud disks are created. The quantity and attributes of these disks are determined by the specified data cloud disk parameters. If multiple data cloud disks and their Device parameters are explicitly specified, but all Device parameters point to the same source image data cloud disk, only one of the specified data cloud disks matches and overwrites the source image data cloud disk. The other specified data cloud disks are silently discarded, and no additional empty data cloud disks are created. If the Device parameter is explicitly specified and matches the Device of a source image data cloud disk, no additional empty data cloud disks are created. The specified data cloud disks map one-to-one with the source image data cloud disks based on the Device parameter. If the specified Size of a data cloud disk is smaller than the Size of the corresponding source image data cloud disk, the system returns HTTP status code 417 and the following error message: Data disk Size can not be less than the image data disk snapshot size for Device '/dev/xvdb'. Total number of data cloud disks (explicitly specified to be mounted on the node + restored from the image): up to 16 for standard cloud disk groups, and up to 4 when Cloud Paralleled File System (CPFS) is enabled.	/dev/xvdb
PerformanceLevel	string	No	The performance metric parameter of the data cloud disk.	PL0
ProvisionedIops	integer	No	The provisioned performance (IOPS). Valid values: 0 to 50,000.	1000
Size	integer	No	The size of the cloud disk.	10
Hostname	string	No	The hostname.	8d13b784-17a9-11ed-bc7b-acde48001122
LoginPassword	string	No	The logon password.	***
NodeId	string	No	The node ID.	e01poc-cn-i7m2wnivf0d
VSwitchId	string	No	The vSwitch ID.	vsw-bp169pi5fj151rrms4sia
VpcId	string	No	The VPC ID.	vpc-0jlasms92fdxqd3wlf8ny
RamRoleName	string	No	The name of the RAM role for the node. You can call the ListRoles operation of RAM to query the RAM roles that you have created. The trusted entity of the configured role must be Lingjun AI Computing Service. Note: You cannot clear an existing role.	xianwen-test-ram-role
SystemDisk	object	No	The system cloud disk information.
Category	string	No	The cloud disk category. Valid values: cloud_essd: ESSD.	cloud_essd
PerformanceLevel	string	No	The performance level of the ESSD used as a system cloud 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.	PL1
Size	integer	No	The size of the system cloud disk. Unit: GB.	9999
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 GPU virtualization is enabled.	false
ZoneId	string	No	The zone ID.	cn-hangzhou-i
IgnoreFailedNodeTasks	boolean	No	Specifies whether failed nodes can be skipped. 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.
IpAllocationPolicy	array<object>	No	The IP allocation policy.
	array<object>	No	The IP allocation policy.
BondPolicy	object	No	The bond policy.
BondDefaultSubnet	string	No	The default bond cluster subnet.	172.168.0.0/24
Bonds	array<object>	No	The bond information.
	object	No	The bond information.
Name	string	No	The bond name.	bond0
Subnet	string	No	The source cluster subnet for IP addresses.	172.16.0.0/24
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.
Name	string	No	The bond name.	bond0
Subnet	string	No	The source cluster subnet for IP addresses.	192.168.1.0/24
MachineType	string	No	The machine type.	efg1.nvga8n
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.
Name	string	No	The bond name.	bond0
Subnet	string	No	The source cluster subnet for IP addresses.	10.0.0.0/24
NodeId	string	No	The node ID.	e01-cn-2r42vq62001
NewVpdInfo	object	No	The VPD configuration information.
CenId	string	No	The Cloud Enterprise Network (CEN) 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 virtual private cloud (VPC).	vpc-0jl2x45apm6odc2c10h25
MonitorVswitchId	string	No	The vSwitch in the VPC.	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 subnet CIDR block.	10.0.1.8/24
SubnetType	string	No	The subnet type.	10.0.2.8/24
ZoneId	string	No	The zone ID.	cn-wulanchabu-b
SecurityGroupId	string	No	The security group ID.	sg-bp1d3dvbh9by7j5rujax
TailIpVersion	string	No	The IP version.	IPv4
VSwitchId	string	No	The vSwitch ID.	vsw-asjdfklj
VSwitchZoneId	string	No	The zone ID of the vSwitch.	cn-shanghai-b
VpcId	string	No	The VPC ID.	vpc-0jl36lqzmc06qogy0t5ll
VpdInfo	object	No	The reused VPD information.
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
Tag	array<object>	No	The resource tags.
	object	No	The list of tags.
Key	string	No	The tag key.	env-name
Value	string	No	The tag value.	dev
Components	array<object>	No	The components (software instances).
	array<object>	No	The component type.
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. Required when ComponentType is ACKEdge. Leave empty for other component types.
	any	No	The node pool configuration, which is used to establish the mapping between node groups and node pools. Required when ComponentType is ACKEdge. Leave empty for other component types.	{ "Options": {}, "Type": "edge", "ResourceGroupId": "rg-acfm2cdxm3zvnt4dsa1s1t65fi", "RelatedNodeGroups": [ "tes" ], "NodeUnitKey": "da", "MaxNodes": 30 }
ComponentType	string	No	The component type. Valid values: ARMS : ARMS monitoring. ACKEdge : ACK edge cluster.	ACKEdge
HpnZone	string	No	The cluster ID. 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.
ClusterId	string	The cluster ID.	i116913051663373010974
RequestId	string	The request ID.	3C683243-7915-57FB-9570-A2932C1C0F78
TaskId	string	The task ID.	i159809891662373011015

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.