Use RunInstances to create an ENS instance - ENS

Create 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 : PrePaid :	PostPaid
ImageId	string	No	The ID of the image. For ARM PCB-based server instances, leave this parameter empty. For other instances, this parameter is required.	m-5si16wo6simkt267p8b7h****
NetDistrictCode	string	No	The code of the region. Note This parameter is not available if ScheduleAreaLevel is set to Region and is required if ScheduleAreaLevel is set to other values.	350000
Carrier	string	No	The Internet service provider (ISP). Note This parameter required if ScheduleAreaLevel is set to Region. If you set ScheduleAreaLevel to Region, a node has multiple ISPs, and you do not specify an ISP, then the create instance uses the ISP of the node. If the node has two ISPs, such as China Mobile and China Unicom, the created instance has two ISPs. You can call the DescribeRegionIsps operation to query ISPs of the edge node.	telecom
ScheduleAreaLevel	string	No	The scheduling level. This parameter specifies area-level scheduling or node-level scheduling. Valid values: Big: greater area Middle: province Small: city Region: node	Region
SchedulingStrategy	string	No	The scheduling policy of the taint. Valid values: Concentrate Disperse Note If ScheduleAreaLevel is set to Region, set this parameter to Concentrate. If ScheduleAreaLevel is set to other values, set this parameter to Concentrate or Disperse based on your business requirements.	Concentrate
EnsRegionId	string	No	The ID of the node. Note This parameter is required if ScheduleAreaLevel is set to Region and is not available if ScheduleAreaLevel is set to other values.	cn-foshan-telecom
Password	string	No	The password that is used to connect to the instance. Note You need to specify at least one of Password, KeyPairName, and PasswordInherit.	testPassword
KeyPairName	string	No	The name of the key pair. Note You need to specify at least one of Password, KeyPairName, and PasswordInherit.	wx2-jumpserver
InternetChargeType	string	No	The bandwidth billing method. Valid values: BandwidthByDay: pay by daily peak bandwidth 95BandwidthByMonth: pay by monthly 95th percentile bandwidth Note This parameter is required if you purchase an ENS instance for the first time. The value that you specified is used as the default value for subsequent purchases.	BandwidthByDay
SystemDisk	object	No	The specification of the system disk.
Size	integer	No	The size of the system disk. Unit: GiB.	50
Category	string	No	The category of the system disk.	local_ssd
DataDisk	array<object>	No	The specifications of data disks.
	object	No	The information about the data disks.
Size	integer	No	The size of a data disk. Unit: GiB.	20
Category	string	No	The category of the disk. Valid values: cloud_efficiency: ultra disk. cloud_ssd: all-flash disk. local_hdd: local HDD. local_ssd: local SSD.	cloud_efficiency
Encrypted	boolean	No	Specifies whether to encrypt the disk. Valid values: true. false (default).	false
KMSKeyId	string	No	The ID of the Key Management Service (KMS) key that is used for the disk. Valid values: true. false (default). Note If you set the Encrypted parameter to true, the default service key is used when the KMSKeyId parameter is empty.	false
Period	integer	No	The unit of the subscription period. If PeriodUnit is set to Day, Period can only be set to 3. If PeriodUnit is Month, Period can be set to 1 to 9 or 12.	1-9,12
InternetMaxBandwidthOut	integer	No	The maximum public bandwidth. If the value of this parameter is greater than 0, a public IP address is assigned to the instance.	1
Amount	integer	No	The number of instances that you want to create. Valid values: 1 to 100.	1
NetWorkId	string	No	The ID of the network. Note This parameter is available only if ScheduleAreaLevel is set to Region and cannot be configured if ScheduleAreaLevel is set to other values. Otherwise, an error occurs.	net-id
VSwitchId	string	No	The ID of the vSwitch. Note This parameter is available only if ScheduleAreaLevel is set to Region and cannot be configured if ScheduleAreaLevel is set to other values. Otherwise, an error occurs.	vsw-5sagnw7m613oulalkd10n****
SecurityId	string	No	The ID of security group.	sg-test
HostName	string	No	The name of the host.	test-HostName
InstanceName	string	No	The name of the instance. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with `http://` or `https://`. It can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-). The default value of this parameter is the value of the InstanceId parameter.	TestName
UniqueSuffix	boolean	No	Specifies whether to append sequential suffixes to the hostname specified by the HostName parameter and to the instance name specified by the InstanceName parameter. The sequential suffixes range from 001 to 999.	True
UserData	string	No	The custom data. The maximum data size is 16 KB. You can specify UserData. UserData must be Base64-encoded.	ZWtest
AutoRenew	boolean	No	Specifies whether to enable auto-renewal for the premium bandwidth plan. Valid values: true. false (default). Note This parameter is not available when InstanceChargeType is set to PostPaid.	true
SchedulingPriceStrategy	string	No	The scheduling price policy. Valid values: PriceHighPriority: The high price prevails. PriceLowPriority: The low price prevails.	PriceHighPriority
PrivateIpAddress	string	No	The private IP address. Note This parameter is available only if ScheduleAreaLevel is set to Region and cannot be configured if ScheduleAreaLevel is set to other values. Otherwise, an error occurs. If you specify a private IP address, the number of instances must be 1. The private IP address takes effect only when the private IP address and the vSwitch ID are not empty.	10.0.XX.XX
PeriodUnit	string	No	The unit of the subscription period. Valid values: Month (default). Day.	Month
PublicIpIdentification	boolean	No	Specifies whether to enable public IP address identification. Valid values: true and false. Default value: false.	true
PasswordInherit	boolean	No	Specifies whether to use the preset password of the image. Valid values: true false Note You need to specify at least one of Password, KeyPairName, and PasswordInherit.	false
InstanceChargeStrategy	string	No	The billing policy of the instance. Valid values: instance: Bills are generated based on instances. If you do not specify this parameter, bills are generated based on users.	instance
BillingCycle	string	No	The billing cycle of computing resources of the instance. Only pay-as-you-go instances are supported. Valid values: Day. Month. Valid values: Month : Month Day : Day	Day
IpType	string	No	The type of the IP address. Valid values: ipv4 (default). ipv6. ipv4Andipv6 (single stack). ipv4Withipv6 (dual stack).	ipv4
AutoUseCoupon	string	No	Specifies whether to use coupons. Default value: true.	true
Tag	array<object>	No	The tags.
	object	No	The tags.
Key	string	No	The key of the tag.	team
Value	string	No	The value of the tag.	tagValue
AutoReleaseTime	string	No	The time when to automatically release 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 Coordinated Universal Time (UTC). If the value of `ss` is not `00`, the start time is automatically rounded down to the nearest minute based on the value of `mm`. The specified time must be at least one hour later than the current time.	2023-06-28T14:38:52Z
SpotStrategy	string	No	The bidding policy for the pay-as-you-go instance. This parameter is valid only when the `InstanceChargeType` parameter is set to `PostPaid`. Valid values: NoSpot: The elastic container instances are pay-as-you-go instances. SpotAsPriceGo: The instance is a preemptible instance for which the market price at the time of purchase is automatically used as the bidding price. Default value: NoSpot.	SpotAsPriceGo
SpotDuration	integer	No	The protection period of the preemptible instance. Unit: hours. Default value: 1. Valid values: 1: After a preemptible instance is created, Alibaba Cloud ensures that the instance is not automatically released within 1 hour. After the 1-hour protection period ends, the system compares the bid price with the market price and checks the resource inventory to determine whether to retain or release the instance. 0: After a preemptible instance is created, Alibaba Cloud does not ensure that the instance runs for 1 hour. The system compares the bid price with the market price and checks the resource inventory to determine whether to retain or release the instance. Alibaba Cloud sends an ECS system event to notify you 5 minutes before the instance is released. Preemptible instances are billed by second. We recommend that you specify an appropriate protection period based on your business requirements.	1
Ipv6AddressCount	integer	No	The number of randomly generated IPv6 addresses assigned to the primary private network interface card.	2
DeletionProtection	boolean	No	The instance release protection property, which specifies whether the instance can be released via the console or API. 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 only restricts manual release operations. It does not affect system-initiated release operations.	false
LaunchTemplateId	string	No	The ID of the launch template.	lt-test
LaunchTemplateName	string	No	The name of the launch template.	lt-test
LaunchTemplateVersion	integer	No	Launch template version	2

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	91E4AFBE-4E35-5D2A-A886-BB477C9953D2
InstanceIds	array	The IDs of instances.
	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.