Use RunInstances to create an ENS instance - ENS - Alibaba Cloud - 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 for 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 ID of the image. Do not specify this parameter for Arm-based instances. This parameter is required for other instance types.	m-5si16wo6simkt267p8b7h****
NetDistrictCode	string	No	The district code. Note This parameter is required for area-level scheduling and is invalid for node-level scheduling.	350000
Carrier	string	No	The carrier. Note This parameter is required for area-level scheduling. For node-level scheduling, if a node supports both China Mobile and China Unicom, two instances are created, one for each carrier. Call the DescribeRegionIsps operation to query the carriers of a node.	telecom
ScheduleAreaLevel	string	No	The scheduling level. You can use this parameter to perform node-level or area-level scheduling. Valid values: Big: large area Middle: province Small: city Region: node	Region
SchedulingStrategy	string	No	The scheduling strategy. Valid values: Concentrate: Deploys instances in a centralized manner. Disperse: Deploys instances in a distributed manner. Note For node-level scheduling, the value must be Concentrate. For area-level scheduling, select a value based on your requirements.	Concentrate
EnsRegionId	string	No	The ID of the node. Note This parameter is required for node-level scheduling and is invalid for area-level scheduling.	cn-foshan-telecom
Password	string	No	The password of the instance. Note You must specify at least one of the following parameters: Password, KeyPairName, and PasswordInherit.	testPassword
KeyPairName	string	No	The name of the key pair. Note You must specify at least one of the following parameters: Password, KeyPairName, and PasswordInherit.	wx2-jumpserver
InternetChargeType	string	No	The billing method for network bandwidth. Valid values: BandwidthByDay: pay by daily peak bandwidth. 95BandwidthByMonth: pay by monthly 95th percentile bandwidth. Note For subsequent purchases, the system defaults to your previously selected billing method.	BandwidthByDay
SystemDisk	object	No	The settings for the system disk.
Size	integer	No	The size of the system disk, in GiB.	50
Category	string	No	The type of the system disk.	local_ssd
DataDisk	array<object>	No	The settings for the data disks.
	object	No	An object that represents a data disk.
Size	integer	No	The size of a data disk, in GiB.	20
Category	string	No	The category of the data disk. Valid values: cloud_efficiency: Ultra Disk cloud_ssd: ESSD local_hdd: local HDD local_ssd: local SSD	cloud_efficiency
Encrypted	boolean	No	Specifies whether to encrypt the data disk. Valid values: true: The data disk is encrypted. false (default): The data disk is not encrypted.	false
KMSKeyId	string	No	The ID of the KMS key for the data disk. true: Yes false (default): No Note If you set `Encrypted` to `true` but do not specify this parameter, the default service key is used.	false
Period	integer	No	The subscription duration. If PeriodUnit is Day, the value can only be 3. If PeriodUnit is Month, the value can be an integer from 1 to 9, or 12.	1-9,12
InternetMaxBandwidthOut	integer	No	The maximum outbound public bandwidth. If this value is greater than 0, a public IP address is automatically assigned.	1
Amount	integer	No	The number of instances to create. Valid values: 1 to 100.	1
NetWorkId	string	No	The ID of the network. Note This parameter can be used only for node-level scheduling. If you specify this parameter for area-level scheduling, an error is reported. If you do not specify a VSwitch, the system only validates this network ID and does not create resources based on it.	net-id
VSwitchId	string	No	The ID of the VSwitch. Note This parameter can be used only for node-level scheduling. If you specify this parameter for area-level scheduling, an error is reported.	vsw-5sagnw7m613oulalkd10n****
SecurityId	string	No	The ID of the security group.	sg-test
HostName	string	No	The hostname of the instance.	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 or a Chinese character and cannot start with `http://` or `https://`. It can contain letters, digits, Chinese characters, colons (:), underscores (_), periods (.), and hyphens (-). If you do not specify this parameter, the instance ID is used by default.	TestName
UniqueSuffix	boolean	No	Specifies whether to append a sequential suffix to the HostName and InstanceName parameters. The suffix is a three-digit number ranging from 001 to 999.	True
UserData	string	No	The user data for the instance. It must be Base64-encoded, and the original data cannot exceed 16 KB in size.	ZWtest
AutoRenew	boolean	No	Specifies whether to enable auto-renewal. Valid values: true: Enables auto-renewal. false (default): Disables auto-renewal. Note This parameter is not applicable to pay-as-you-go instances.	true
SchedulingPriceStrategy	string	No	The price-based scheduling strategy. Valid values: PriceHighPriority: Prioritizes nodes with higher prices. PriceLowPriority: Prioritizes nodes with lower prices.	PriceHighPriority
PrivateIpAddress	string	No	The private IP address of the instance. Note This parameter can be used only for node-level scheduling. If you specify this parameter for area-level scheduling, an error is reported. If you specify a private IP address, you can create only one instance. This parameter takes effect only if you also specify a VSwitchId.	10.0.XX.XX
PeriodUnit	string	No	The unit of the subscription duration. Valid values: Month (default): monthly. Day: daily.	Month
PublicIpIdentification	boolean	No	Specifies whether to assign a public IP address to the instance. Valid values: true: A public IP address is assigned. false: A public IP address is not assigned. 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 You must specify at least one of the following parameters: Password, KeyPairName, and PasswordInherit.	false
InstanceChargeStrategy	string	No	The billing policy for the instance. Valid values: instance: Bills the instance individually. If you do not specify this parameter, billing is performed at the account level by default.	instance
BillingCycle	string	No	The billing cycle for the computing resources of the instance. This parameter applies only to pay-as-you-go instances that are billed at the instance level. Valid values: Day: daily. Month: monthly. Valid values: Month : Month Day : Day	Day
IpType	string	No	The IP address type. Valid values: ipv4 (default): IPv4. ipv6: IPv6. ipv4Andipv6: IPv4 and IPv6 (single-stack). ipv4Withipv6: IPv4 and IPv6 (dual-stack).	ipv4
AutoUseCoupon	string	No	Specifies whether to automatically apply coupons. Defaults to true.	true
Tag	array<object>	No	The tags to add to the instance.
	object	No	An object that represents a tag.
Key	string	No	The key of the tag.	team
Value	string	No	The value of the tag. The value can be up to 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	tagValue
AutoReleaseTime	string	No	The time at which the pay-as-you-go instance is automatically released. Specify the time in the ISO 8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time must be in UTC. If you specify a non-zero value for seconds (`ss`), the time is rounded down to the beginning of the minute. The release time must be at least one hour after the current time.	2023-06-28T14:38:52Z
SpotStrategy	string	No	The bidding strategy for the pay-as-you-go instance. This allows you to request a spot instance. This parameter is valid only when `InstanceChargeType` is set to `PostPaid`. Valid values: NoSpot: a regular pay-as-you-go instance. SpotAsPriceGo: A spot instance. The system automatically places bids at the current market price. Default value: NoSpot.	SpotAsPriceGo
SpotDuration	integer	No	The protection period for the spot instance. Unit: hours.	1
Ipv6AddressCount	integer	No	The number of randomly generated IPv6 addresses to assign to the primary private ENI (elastic network interface).	2
DeletionProtection	boolean	No	Specifies whether to enable deletion protection for the instance. This feature prevents you from releasing the instance in the console or by calling an API. Valid values: true: Enables deletion protection. false: Disables deletion protection. Default value: false. Note This protection applies only to manual release actions and does not prevent system-initiated releases.	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	The version of the launch template.	2
VpdId	string	No
VpdVSwitchIds	array	No
	string	No
DeploymentSetId	string	No

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	91E4AFBE-4E35-5D2A-A886-BB477C9953D2
InstanceIds	array	The IDs of the created instances.
	string	The ID of a created instance.	['i-5xxxx26dix05koz15l5413j25o', 'i-5sdmxxxx']
OrderId	string	The ID of the associated order.	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.