Property | Type | Required | Editable | Description | Constraint |
ResourceGroupId | String | No | Yes | The ID of the resource group. | None. |
SpotInterruptionBehavior | String | No | No | The interruption mode of the preemptible instance. | Set the value to Terminate. A value of Terminate specifies that the system directly releases preemptible instances. Default value: Terminate. |
ZoneIds | List | No | No | The zones. | None. |
SpotDuration | Integer | No | No | The protection period of the preemptible instance. | Valid values: 0 to 6. Unit: hour. 0: If you set this property to 0, the preemptible instance does not have a protection period. 2 to 6: The retention periods of 2, 3, 4, 5, and 6 hours are in invitational preview. If you want to set this property to one of the values, submit a ticket. 1 (default).
|
SecurityGroupIds | List | No | No | The IDs of the security groups. | You must specify SecurityGroupId or SecurityGroupIds. |
ImageId | String | No | Yes | The ID of the image. You can use a public image, a custom image, or an Alibaba Cloud Marketplace image. | To specify a public image, you can enter a partial image ID instead of the complete image ID. Public images support fuzzy search. Examples: If you enter ubuntu, the system matches it with the following image ID: ubuntu16_0402_64_20G_alibase_20170818.vhd. If you enter ubuntu_14, the system matches it with the following image ID: ubuntu_14_0405_64_20G_alibase_20170824.vhd. If you enter ubuntu*14*32, the system matches it with the following image ID: ubuntu_14_0405_32_40G_alibase_20170711.vhd. If you enter ubuntu_16_0402_32, the system matches it with the following image ID: ubuntu_16_0402_32_40G_alibase_20170711.vhd.
|
InstanceType | String | Yes | Yes | The ECS instance type. | For more information about ECS instance types, see Overview of instance families. |
SecurityGroupId | String | No | No | The ID of the security group. | You must specify SecurityGroupId or SecurityGroupIds. |
SecurityEnhancementStrategy | String | No | No | Specifies whether to enable security hardening. | Valid values: |
Description | String | No | Yes | The description. | The description must be 2 to 256 characters in length. |
InstanceName | String | No | Yes | The name of the ECS 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 (_), and hyphens (-). If you leave this property empty, the instance ID is used by default. |
Password | String | No | Yes | The logon password of the ECS instance. | The password must be 8 to 30 characters in length. It must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. The following special characters are supported: ( ) ' ~ ! @ # $ % ^ & * - + = | { } [ ] : ; < > , . ? / - . If you specify this property, we recommend that you call Resource Orchestration Service (ROS) API operations over HTTPS to prevent password leaks. |
PasswordInherit | Boolean | No | No | Specifies whether to use the preset password of the image. | Valid values: Note If you set this property to true, you must leave Password empty and make sure that the selected image has a preset password. |
HostName | String | No | Yes | The hostname of the ECS instance. | The hostname must be at least two characters in length. It cannot start or end with a period (.) or hyphen (-). It cannot contain consecutive periods (.) or consecutive hyphens (-). Windows: The hostname can be up to 15 characters in length, and can contain letters, digits, and hyphens (-). It cannot contain periods (.) or only digits. Other operating systems such as Linux: The hostname can be up to 30 characters in length. Separate multiple segments in the hostname with periods (.). Each segment can contain letters, digits, and hyphens (-).
|
AllocatePublicIP | Boolean | No | No | Specifies whether to assign a public IP address. | Valid values: Note If you set InternetMaxBandwidthOut to a value that is greater than 0, the system assigns a public IP address. |
PrivateIpAddress | String | No | No | The private IP address of the ECS instance in a virtual private cloud (VPC). | The specified IP address must not be used by other instances in the VPC. |
InternetChargeType | String | No | Yes | The metering method for Internet usage. | Valid values: |
InternetMaxBandwidthOut | Integer | No | Yes | The maximum outbound public bandwidth. | Valid values: 0 to 100. Default value: 0. Unit: Mbit/s. |
IoOptimized | String | No | No | Specifies whether to create an I/O optimized instance. | Valid values: |
DiskMappings | List | No | Yes | The data disks that you want to attach to the ECS instance. | You can attach up to 16 data disks. For more information, see DiskMappings syntax and DiskMappings properties. |
SystemDiskCategory | String | No | Yes | The category of the system disk. | Valid values: For non-I/O optimized instances of a retired instance type, the default value is cloud. For instances of other types, the default value is cloud_efficiency. |
SystemDiskDescription | String | No | No | The description of the system disk. | None. |
SystemDiskDiskName | String | No | No | The name of the system disk. | 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 (_), and hyphens (-). |
SystemDiskSize | Number | No | Yes | The size of the system disk. | Valid values: 20 to 500. Unit: GB. If you use a custom image to create a system disk, make sure that the size of the system disk is larger than the size of the custom image. |
Tags | List | No | Yes | The custom tags that you want to add to the ECS instance. | You can specify up to 20 tags in the following format: [{"Key": "tagKey", "Value": "tagValue"},{"Key": "tagKey2", "Value": "tagValue2"}] . For more information, see Tags syntax and Tags properties. |
UserData | String | No | Yes | The user data that you want to specify when you create the ECS instance. | The user data can be up to 16 KB in size. You do not need to convert the data into Base64-encoded strings. If the user data contains special characters, you must add the escape character (\) before each special character. |
ZoneId | String | No | No | The ID of the zone. | None. |
HpcClusterId | String | No | No | The ID of the Elastic High Performance Computing (E-HPC) cluster to which the ECS instance belongs. | None. |
VpcId | String | No | No | The ID of the VPC. | None. |
VSwitchId | String | No | No | The ID of the vSwitch. | None. |
InstanceChargeType | String | No | No | The billing method of the ECS instance. | Valid values: PrePaid: subscription. If you set this property to PrePaid, make sure that your account has sufficient balance. If your account does not have sufficient balance, the ECS instance fails to be created. PostPaid (default): pay-as-you-go.
|
Period | Number | No | No | The billing cycle. | Period is required if InstanceChargeType is set to PrePaid. Period is optional if InstanceChargeType is set to PostPaid. |
KeyPairName | String | No | Yes | The name of the key pair that is used to log on to the ECS instance. | For ECS Windows instances, you can ignore KeyPairName. For ECS Linux instances, password-based logons are disabled during initialization. To improve the security of your instance, we recommend that you use key pairs for logons. |
RamRoleName | String | No | No | The name of the Resource Access Management (RAM) role for the ECS instance. | For more information, see CreateRole and ListRoles. |
SpotPriceLimit | String | No | No | The maximum hourly price of the ECS instance. | The value of this property can contain up to three decimal places. This property takes effect when SpotStrategy is set to SpotWithPriceLimit. |
SpotStrategy | String | No | No | The bidding policy for a pay-as-you-go instance. | You must specify this property when InstanceChargeType is set to PostPaid. Valid values: NoSpot (default): The instance is created as a regular pay-as-you-go instance. SpotWithPriceLimit: The instance is created as a preemptible instance that has a user-defined maximum hourly price. SpotAsPriceGo: The instance is created as a preemptible instance whose bidding price is based on the market price at the time of purchase. The market price can be up to the pay-as-you-go price.
|
DedicatedHostId | String | No | No | The ID of the dedicated host on which you want to create the ECS instance. | You can call the DescribeDedicatedHosts operation to query the IDs of dedicated hosts. You cannot create preemptible instances on dedicated hosts. If you specify this property, the system ignores the values of SpotStrategy and SpotPriceLimit in the request. |
PeriodUnit | String | No | No | The unit of the billing cycle of the ECS instance. | Valid values: |
AutoRenewPeriod | Number | No | No | The auto-renewal period. | You must specify this property when AutoRenew is set to True. Valid values when PeriodUnit is set to Week: 1, 2, and 3. Valid values when PeriodUnit is set to Month: 1, 2, 3, 6, and 12.
|
AutoRenew | String | No | No | Specifies whether to enable auto-renewal. | Valid values: You must specify this property when InstanceChargeType is set to PrePaid. |
DeletionProtection | Boolean | No | Yes | Specifies whether to enable deletion protection for the ECS instance. You can use this property to determine whether you can delete the instance by using the ECS console or DeleteInstance operation. | Valid values: Note This property takes effect only for pay-as-you-go instances. This property can protect instances against manual deletion but cannot protect instances against automatic deletion. |
DeploymentSetId | String | No | No | The ID of the deployment set. | None. |
SystemDiskPerformanceLevel | String | No | Yes | The performance level (PL) of the ESSD that you want to use as the system disk. | Valid values: PL0: An ESSD can deliver up to 10,000 random read/write IOPS. PL1 (default): An ESSD can deliver up to 50,000 random read/write IOPS. PL2: An ESSD can deliver up to 100,000 random read/write IOPS. PL3: An ESSD can deliver up to 1,000,000 random read/write IOPS.
For more information about how to select the PLs of ESSDs, see ESSDs. |
CreditSpecification | String | No | Yes | The performance mode of the burstable instance. | Valid values: Standard: standard mode. For more information, see the "Standard mode" section of the Overview topic. Unlimited: unlimited mode. For more information, see the "Unlimited mode" section of the Overview topic.
|
PrivatePoolOptions | Map | No | No | The options of the private pool that is used to start the ECS instance. | For more information, see PrivatePoolOptions properties. |
StorageSetId | String | No | No | The ID of the storage set. | None. |
HttpTokens | String | No | Yes | Specifies whether to forcefully use the security hardening mode (IMDSv2) to access the instance metadata. | Valid values: optional (default): does not forcefully use the security hardening mode (IMDSv2) to access the instance metadata. required: forcefully uses the security hardening mode (IMDSv2) to access the instance metadata. After you set this property to required, you cannot access the instance metadata in normal mode.
|
HttpEndpoint | String | No | Yes | Specifies whether to enable the access channel for the instance metadata. | Valid values: enabled (default) disabled
|
Tenancy | String | No | No | Specifies whether to create the ECS instance on a dedicated host. | Valid values: default (default): does not create the ECS instance on a dedicated host. host: creates the ECS instance on a dedicated host. If you do not specify DedicatedHostId , Alibaba Cloud selects a dedicated host for the instance.
|
StorageSetPartitionNumber | Integer | No | No | The maximum number of partitions in the storage set. | Valid values: integers greater than or equal to 2. |
DeploymentSetGroupNo | Integer | No | No | The group number of the deployment set group to which you want to deploy the instance. If the deployment set specified by DeploymentSetId uses the high availability group strategy (AvailabilityGroup), you can use DeploymentSetGroupNo to specify a deployment set group in the deployment set. | Valid values: 1 to 7. |
Affinity | String | No | No | Specifies whether to associate the ECS instance on a dedicated host with the dedicated host. | Valid values: default (default): does not associate the ECS instance on a dedicated host with the dedicated host. When you restart an instance that was stopped in economical mode and the original dedicated host of the instance has insufficient resources, the instance is deployed to another dedicated host in the automatic deployment resource pool. host: associates the ECS instance on a dedicated host with the dedicated host. When you restart an instance that was stopped in economical mode, the instance remains on the original dedicated host. If the original dedicated host has insufficient resources, the instance fails to be restarted.
|
UseAdditionalService | Boolean | No | No | Specifies whether to use the system configurations for virtual machines. Alibaba Cloud provides the Network Time Protocol (NTP) and Key Management Service (KMS) system configurations for Windows and the NTP and Yellowdog Updater, Modified (YUM) system configurations for Linux. | Valid values: |
ImageFamily | String | No | No | The name of the image family. | You can specify this property to query the most recent available image that belongs to the specified image family and use the image to create an instance. If you specify ImageId , you cannot specify ImageFamily. If you do not specify ImageId but use LaunchTemplateId or LaunchTemplateName to specify a launch template for which ImageId is defined, you cannot specify ImageFamily. If you do not specify ImageId but use LaunchTemplateId or LaunchTemplateName to specify a launch template for which ImageId is not defined, you can specify ImageFamily. If you do not specify ImageId , LaunchTemplateId , or LaunchTemplateName , you can specify ImageFamily.
Note For more information about the image families that are associated with Alibaba Cloud official images, see Overview. |