ExtendCluster - Platform For AI - Alibaba Cloud Documentation Center

Scales out a cluster.

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:ExtendCluster

update

*Cluster

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

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	No	The cluster ID.	i15b480fbd2fcdbc2869cd80
NodeGroups	array<object>	No	The node groups.
	array<object>	No	The node group.
Nodes	array<object>	No	The list of nodes.
	array<object>	No	The list of nodes.
Hostname	string	No	The hostname.	d044d220-33fd-11ed-86a6
LoginPassword	string	No	The logon password.	***
NodeId	string	No	The node ID.	e01-cn-zvp2zdpy601
VpcId	string	No	The virtual private cloud (VPC) ID.	vpc-0jlasms92fdxqd3wlf8ny
VSwitchId	string	No	The vSwitch ID.	vsw-bp169pi5fj151rrms4sia
DataDisk	array<object>	No	The specifications of the data disks.
	object	No	The specifications of the data disk.
DeleteWithNode	boolean	No	Indicates whether to release the data disk when the node is released.	true
Category	string	No	The type.	cloud_essd
Size	integer	No	The disk size.	80
PerformanceLevel	string	No	The performance parameters of the data disk.	PL0
BurstingEnabled	boolean	No	Indicates whether to enable performance burst.	true
ProvisionedIops	integer	No	The provisioned input/output operations per second (IOPS). Valid values: 0 to 50,000.	1000
HyperNodes	array<object>	No	The list of hypernodes.
	array<object>	No	The hypernode information.
Hostname	string	No	The hostname.	liliang-rmn7stf7-0000
LoginPassword	string	No	The logon password.	***
HyperNodeId	string	No	The hypernode ID.	e01-cn-2r42tmj4z02
VpcId	string	No	The VPC ID.	vpc-0jl8gs7qmx89739e210dn
VSwitchId	string	No	The vSwitch ID.	vsw-8vbobo4cvzsygw98f4j6b
DataDisk	array<object>	No	The list of disk information.
	object	No	The disk information.
DeleteWithNode	boolean	No	Indicates whether to release the data disk when the node is released.	True
Category	string	No	The disk type. Valid value: cloud_essd: enhanced SSD (ESSD).	cloud_essd
Size	integer	No	The disk size. Unit: GiB.	10
PerformanceLevel	string	No	The performance level of the ESSD that you create as a system disk. Valid values: PL0: A single disk can deliver up to 10,000 random read/write IOPS. PL1: A single disk can deliver up to 50,000 random read/write IOPS.	PL1
BurstingEnabled	boolean	No	Indicates whether to enable performance burst.	false
ProvisionedIops	integer	No	The provisioned read/write IOPS of the AutoPL ESSD.	9600
NodeGroupId	string	No	The node group ID.	i16d4883a46cbadeb4bc9
UserData	string	No	The custom data.	#!/bin/sh echo "Hello World. The time is now $(date -R)!" \| tee /root/userdata_test.txt
ZoneId	string	No	The zone ID.	cn-hangzhou-i
Amount	integer	No	The number of nodes to add for the scale-out. Valid values: 0 to 500. If you set this to 0, existing nodes are used. If you set this to a value from 1 to 500, that number of new nodes are purchased. The default value is 0.	4
ChargeType	string	No	The billing method of the nodes. This parameter is valid only when Amount is not 0. Valid values: PREPAY: subscription. POSTPAY: pay-as-you-go. Default value: PREPAY.	PostPaid
Period	integer	No	The subscription duration of the nodes. Unit: month. Valid values: 1, 6, 12, 24, 36, and 48. This parameter is valid only when Amount is not 0 and ChargeType is set to PREPAY.	6
AutoRenew	boolean	No	Indicates whether to enable auto-renewal for the purchased nodes. This parameter is valid only when Amount is not 0 and ChargeType is set to PREPAY or POSTPAY. Valid values: True: enables auto-renewal. False: disables auto-renewal. Default value: False.	True
Hostnames	array	No	The hostnames of the purchased nodes. This parameter is valid only when Amount is not 0.
	string	No	The hostname.	i22c11282.eu95sqa
LoginPassword	string	No	The logon password for the purchased nodes. This parameter is valid only when Amount is not 0.	skkO(*89Y
NodeTag	array<object>	No	The node tags.
	object	No	The node tag.
Key	string	No	The key of the node tag.	key_my
Value	string	No	The value of the node tag.	value_my
VpcId	string	No	The VPC ID.	vpc-0jl3b0c0ukydlfezr13n6
VSwitchId	string	No	The vSwitch ID.	vsw-uf65m8xqjgy55xj9jw92n
IgnoreFailedNodeTasks	boolean	No	Indicates whether to skip failed nodes. Default value: False.	False
VpdSubnets	array	No	The list of cluster subnets.
	string	No	A vpd subnet.	["subnet-3od2fe","subnet-fdo3dv"]
IpAllocationPolicy	array<object>	No	The IP address allocation policies. This is an array of policy objects. You can combine multiple policy objects. Each object must contain only one policy type.
	array<object>	No	The IP address allocation policy.
BondPolicy	object	No	Specifies the cluster subnet ID based on the bond name.
BondDefaultSubnet	string	No	The default bond cluster subnet.	subnet-3od2fe
Bonds	array<object>	No	The bond information.
	object	No	The bond object.
Name	string	No	The bond name.	Bond0
Subnet	string	No	The source cluster subnet of the IP address.	subnet-3od2fe
MachineTypePolicy	array<object>	No	The machine type allocation policy.
	array<object>	No	The policy object.
Bonds	array<object>	No	The bond information.
	object	No	The bond object.
Name	string	No	The bond name.	Bond0
Subnet	string	No	The source cluster subnet of the IP address.	subnet-fdo3dv
MachineType	string	No	The machine type.	efg1.nvga1
NodePolicy	array<object>	No	The node allocation policy.
	array<object>	No	The policy object.
Bonds	array<object>	No	The bond information.
	object	No	The bond object.
Name	string	No	The bond name.	Bond0
Subnet	string	No	The source cluster subnet of the IP address.	subnet-fdo3dv
NodeId	string	No	The node ID.	i-3fdodw2
Hostname	string	No	The hostname.	a100-xa5dza28-0085
VSwitchZoneId	string	No	The zone ID of the vSwitch. Valid values: cn-beijing-d : cn-beijing-b	cn-shanghai-b

Response elements

Element	Type	Description	Example
	object	Response parameters.
RequestId	string	The request ID.	03668372-18FF-5959-98D9-6B36A4643C7A
TaskId	string	The task ID.	i158475611663639202234

Examples

Success response

JSON format

{
  "RequestId": "03668372-18FF-5959-98D9-6B36A4643C7A",
  "TaskId": "i158475611663639202234"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.