Use RunInstances to create an ENS instance - ENS - Alibaba Cloud - ENS

Creates pay-as-you-go or subscription ENS compute instances.

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

ens:RunInstances

create

*Instance

acs:ens:*:{#accountId}:instance/*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceType	string	No	The instance type.	ens.sn1.small
InstanceChargeType	string	No	The billing method of the instance. Valid values: PrePaid: subscription. PostPaid: pay-as-you-go. Valid values: PostPaid : Pay-as-you-go. PrePaid : Subscription.	PostPaid
ImageId	string	No	The image ID. This parameter cannot be specified for ARM-based instances. This parameter is required for other instance types.	m-5si16wo6simkt267p8b7h****
NetDistrictCode	string	No	The region code. Note This parameter is required for region-level scheduling and is invalid for node-level scheduling.	350000
Carrier	string	No	The carrier. Note This parameter is required for region-level scheduling. For node-level scheduling, if a node has multiple carriers and you do not specify a carrier, instances are created for each carrier on the node. For example, if a node has both China Mobile and China Unicom carriers, instances with two ISPs are created. You can call DescribeRegionIsps to query the carrier information of a node.	telecom
ScheduleAreaLevel	string	No	The scheduling level. Use this parameter to specify node-level or region-level scheduling. Valid values: Big: major area Middle: province Small: city Region: node	Region
SchedulingStrategy	string	No	The scheduling strategy. Valid values: Concentrate: concentrated Disperse: dispersed Note For node-level scheduling, the value is Concentrate. For region-level scheduling, select a value based on your requirements.	Concentrate
EnsRegionId	string	No	The node ID. Note This parameter is required for node-level scheduling and is invalid for region-level scheduling.	cn-foshan-telecom
Password	string	No	The instance password. Note Specify at least one of Password, KeyPairName, and PasswordInherit.	testPassword
KeyPairName	string	No	The key pair name. Note Specify at least one of Password, KeyPairName, and PasswordInherit.	wx2-jumpserver
InternetChargeType	string	No	Billable methods for bandwidth. Valid values: BandwidthByDay: daily peak bandwidth 95BandwidthByMonth: monthly 95th percentile bandwidth Note You can select a billing method only for the first purchase. Subsequent purchases use the billing method selected during the first purchase by default.	BandwidthByDay
SystemDisk	object	No	The system cloud disk specifications.
Size	integer	No	The size of the system cloud disk. Unit: GiB.	50
Category	string	No	The type of the system cloud disk.	local_ssd
DataDisk	array<object>	No	The data cloud disk specifications.
	object	No	The list of data cloud disks.
Size	integer	No	The size of the data cloud disk. Unit: GiB.	20
Category	string	No	The disk category. Valid values: cloud_efficiency: ultra cloud disk cloud_ssd: all-flash cloud disk local_hdd: local HDD local_ssd: local SSD	cloud_efficiency
Encrypted	boolean	No	Specifies whether to encrypt the cloud disk. Valid values: true: encrypts the cloud disk. false (default): does not encrypt the cloud disk.	false
KMSKeyId	string	No	The ID of the KMS key used by the cloud disk. Valid values: true: encrypts the cloud disk. false (default): does not encrypt the cloud disk. Note If Encrypted is set to true and KMSKeyId is empty, the default service key is used.	false
Period	integer	No	The duration of the purchased resource. If PeriodUnit is set to Day, Period can only be set to 3. If PeriodUnit is set to Month, Period can be set to 1-9 or 12.	1
InternetMaxBandwidthOut	integer	No	The maximum public bandwidth. If the value of this parameter is greater than 0, a public IP address is automatically assigned to the instance.	1
Amount	integer	No	The number of instances to create. Valid values: 1 to 100.	1
NetWorkId	string	No	The network ID. Note This parameter can only be used for node-level scheduling. An error is returned if this parameter is specified for region-level scheduling. If you do not specify vSwitch information, only the validity of the network ID is verified. The actual resource creation does not use this network ID.	net-id
VSwitchId	string	No	The vSwitch ID. Note This parameter can only be used for node-level scheduling. An error is returned if this parameter is specified for region-level scheduling.	vsw-5sagnw7m613oulalkd10n****
SecurityId	string	No	The security group ID.	sg-test
HostName	string	No	The hostname.	test-HostName
InstanceName	string	No	The instance name. The name must be 2 to 128 characters in length and must start with a letter or Chinese character. It cannot start with `http://` or `https://`. It can contain Chinese characters, letters, digits, colons (:), underscores (_), periods (.), or hyphens (-). Default value: the InstanceId of the instance.	TestName
UniqueSuffix	boolean	No	Specifies whether to add sequential suffixes to HostName and InstanceName. The sequential suffixes start from 001 and cannot exceed 999.	True
UserData	string	No	The custom user data. Maximum size: 16 KB. You can pass in UserData information. UserData is Base64-encoded.	ZWtest
AutoRenew	boolean	No	Specifies whether to enable auto-renewal. Valid values: true: enables auto-renewal. false: does not enable auto-renewal. (Default) Note This parameter is invalid for pay-as-you-go instances.	true
SchedulingPriceStrategy	string	No	The scheduling price strategy. Valid values: PriceHighPriority: high price first PriceLowPriority: low price first Valid values: PriceHighPriority : High price first. PriceLowPriority : Low price first.	PriceHighPriority
PrivateIpAddress	string	No	The private IP address. Note This parameter can only be used for node-level scheduling. An error is returned if this parameter is specified for region-level scheduling. If a private IP address is specified, the number of instances can only be 1. The private IP address takes effect only when both the private IP address and vSwitch ID are specified.	10.0.XX.XX
PeriodUnit	string	No	The unit of the purchase duration. Valid values: Month (default): monthly purchase. Day: daily purchase. Valid values: Month : Month. Day : Day.	Month
PublicIpIdentification	boolean	No	Specifies whether to enable public IP identification. Valid values: true: enables public IP identification. false: does not enable public IP identification. Default value: true.	true
PasswordInherit	boolean	No	Specifies whether to use the preset password of the image. Valid values: true: uses the preset password. false: does not use the preset password. Note Specify at least one of Password, KeyPairName, and PasswordInherit.	false
InstanceChargeStrategy	string	No	The instance billing strategy. Valid values: instance: instance-level billing. If not specified, the default is user-level billing.	instance
BillingCycle	string	No	The billing cycle for instance compute resources. Only instance-level pay-as-you-go is supported. Valid values: Day: daily billing. Month: monthly billing. Valid values: Month : Month Day : Day Hour : Hour.	Day
IpType	string	No	The IP type. Valid values: ipv4 (default): IPv4. ipv6: IPv6. ipv4Andipv6: IPv4 and IPv6 (single stack). ipv4Withipv6: IPv4 and IPv6 (dual-stack). Valid values: ipv4 : IPv4 ipv6 : IPv6 ipv4Andipv6 : IPv4 and IPv6 ipv4Withipv6 : IPv4 and IPv6 dual-stack.	ipv4
AutoUseCoupon	string	No	Specifies whether to use coupons. Default value: true (AutoUseCoupon=true).	true
Tag	array<object>	No	The tags that are bound to the instance.
	object	No	The array of tag key-value pairs.
Key	string	No	The custom tag key.	team
Value	string	No	The tag value. The tag value cannot exceed 128 characters in length, and cannot start with `aliyun` or `acs:`, or contain `http://` or `https://`.	tagValue
AutoReleaseTime	string	No	The automatic release time of the pay-as-you-go instance. Specify the time in the ISO 8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time must be in UTC. If the value of seconds (`ss`) is not `00`, the time is automatically set to the start of the current minute (`mm`). The earliest release time is one hour after the current time.	2023-06-28T14:38:52Z
SpotStrategy	string	No	The bidding policy for the pay-as-you-go instance. This parameter takes effect when the `InstanceChargeType` parameter is set to `PostPaid`. Valid values: NoSpot: a regular pay-as-you-go instance. SpotAsPriceGo: the system automatically bids at the current market price. Default value: NoSpot. Valid values: SpotAsPriceGo : the system automatically bids. NoSpot : regular pay-as-you-go.	SpotAsPriceGo
SpotDuration	integer	No	The protection period of the spot instance. Unit: hours.	1
Ipv6AddressCount	integer	No	The number of randomly generated IPv6 addresses to assign to the primary ENI of the private network.	2
DeletionProtection	boolean	No	The release protection property of the instance. Specifies whether the instance can be released from the console or by calling an API operation. Valid values: true: Enables instance release protection. false: Disables instance release protection. Default value: false. Note This property applies only to pay-as-you-go instances and can only restrict manual release operations. It does not take effect on system-initiated release operations.	false
LaunchTemplateId	string	No	The ID of the instance launch template.	lt-test
LaunchTemplateName	string	No	The name of the instance launch template.	lt-test
LaunchTemplateVersion	integer	No	The version of the instance launch template.	2
VpdId	string	No	The VPD network ID.	vpd-5s7xxxxxxx
VpdVSwitchIds	array	No	The list of VPD vSwitch IDs.
	string	No	The list of VPD vSwitch IDs.	vsw-5s7xxxxxxx
DeploymentSetId	string	No	The deployment set ID.	ds-5s1p6x2l3r4b****
AutoInstallCloudAssistant	boolean	No	Specifies whether to automatically install the Cloud Assistant client on the instance.
CloudAssistantRegion	string	No	The region for Cloud Assistant access. Valid values: cn-zhangjiakou (Zhangjiakou) and ap-southeast-1 (Singapore). Valid values: ap-southeast-1 : Singapore. cn-zhangjiakou : Zhangjiakou.	cn-zhangjiakou

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	91E4AFBE-4E35-5D2A-A886-BB477C9953D2
InstanceIds	array	The list of instance IDs.
	string	The list of instance IDs.	['i-5xxxx26dix05koz15l5413j25o', 'i-5sdmxxxx']
OrderId	string	The order ID.	213177957850399

Examples

Success response

JSON format

{
  "RequestId": "91E4AFBE-4E35-5D2A-A886-BB477C9953D2",
  "InstanceIds": [
    "['i-5xxxx26dix05koz15l5413j25o', 'i-5sdmxxxx']"
  ],
  "OrderId": "213177957850399"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

HTTP status code	Error code	Error message	Description
400	Invalid%s	The specified parameter %s is invalid.
400	Missing%s	You must specify the parameter %s.
400	SaleControlVerificationFailedInstanceDistrict	The regional sales constraint verification failed, please re-match or contact the product.	Regional sales constraint verification failed, please re-match
400	ens.interface.error	Failed to call API.
400	OrderFailed	Order failed, please try again.	Order failed, please try again
400	SystemUseCouponFailed	Failed to use coupon.	Failed to use coupon
400	SystemUseStoredCardFailed	Failed to use stored value card.	Failed to use stored value card
400	System.SystemError	system error.	system error.
400	SystemCanRefundCheckFailed	The business rule check of the cloud product fails, and this order cannot be refunded.	The business rule check of the cloud product fails, and this order cannot be refunded.
400	SystemOtsSystem	ots storage error.	ots storage error.
400	SystemQueryImmortalError	Failed to call Juxiange.	Failed to call Juxiange.
400	SystemQueryInstanceInfoFailed	Failed to find instance information.	Failed to find instance information
400	SystemResellerPayCalRefundUnitError	Ecological payment channel calculation unsubscribe information error.	Ecological payment channel calculation unsubscribe information error.
400	SystemSaleValidateFailed	Sales Expression Validation System Error.	Sales Expression Validation System Error
400	SystemTransferDeleteOldResourceFailed	Failed to delete the transferred instance in the transfer order.	Failed to delete the transferred instance in the transfer order.
400	SystemUnSupportOperationType	Unsupported operation type.	Unsupported operation type.
400	RiskRiskControlRejection	Risk Control Rejection.	Risk Control Rejection.
400	AuthRamAuthFailed	ram sub-account authentication failed.
400	CommodityInvalidComponent	The module you purchased is illegal, please re-select.	The module you purchased is illegal, please re-select.
400	CommodityInvalidItemCode	Specification code illegal.	Specification code illegal.
400	PriceHsfTimeoutError	Time out when calling the request for quotation interface.	Time out when calling the request for quotation interface.
400	PricePatingConfigError	Inquiry related goods configuration error.	Inquiry related goods configuration error.
400	PricePricingPlanResultNotFound	Pricing plan price result not found.	Pricing plan price result not found.
400	PriceRatingGetRatingpricingPlan	Obtain a valid pricing plan exception.	Obtain a valid pricing plan exception.
400	OrderAbnormalResourceStatusForRenew	Invalid resource status for renewal.	Invalid resource status for renewal.
400	OrderAccountStatusIllegal	Illegal account status.	Illegal account status.
400	OrderArrearage	User Arrears.	User Arrears.
400	OrderBidUserOrderForbidden	Bid users cannot buy on the official website.	Bid users cannot buy on the official website.
400	OrderCaptureFailed	The paid order of the instance has not been deducted successfully.	The paid order of the instance has not been deducted successfully.
400	OrderExistsReleasedInstances	There are already released instances.	There are already released instances.
400	OrderGroupOrderSizeOverflow	The quantity of bound combined payment order exceeds the limit.	The quantity of bound combined payment order exceeds the limit.
400	OrderHomeCurrencyCanNotDowngrade	Users in current currency cannot downgrade.	Users in current currency cannot downgrade.
400	OrderHomeCurrencyCanNotUpgradeByValueTransfer	Users of current currency cannot upgrade through residual value transfer.	Users of current currency cannot upgrade through residual value transfer.
400	OrderInstanceHasInactiveChange	Instances exist temporary upgrade.	Instances exist temporary upgrade.
400	OrderInstHasUnpaidOrder	The instance has an unpaid order.	The instance has an unpaid order.
400	OrderInstHasUnsettledBills	The instance has an unsettled bill.	The instance has an unsettled bill.
400	OrderLatestOrderIsHandling	Recent order is being processed, please try again later.	Recent order is being processed, please try again later.
400	OrderMainOrderSizeOverflow	The quantity of the main order exceeds the limit.	The quantity of the main order exceeds the limit.
400	OrderMissingModuleInfoError	Module parameter not specified.	Module parameter not specified.
400	OrderNoRealNameAuthentication	No real-name authentication.	No real-name authentication.