Domain name for API request: cvm.tencentcloudapi.com.
This API is used to create one or more instances with a specified configuration.
ID list will be returned after you successfully make a creation request. However, it does not mean the creation has been completed. The state of the instance will be Creating during the creation. You can use DescribeInstances to query the status of the instance. If the status changes from Creating to Running, it means that the instance has been created successfully.A maximum of 10 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cvm.ap-shanghai-fsi.tencentcloudapi.com
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common parameter. The value used for this API: RunInstances. |
| Version | Yes | String | Common parameter. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| InstanceChargeType | No | String | The instance billing method. Valid values: POSTPAID_BY_HOUR: hourly, pay-as-you-goCDHPAID: you are only billed for CDH instances, not the CVMs running on the CDH instances.Default value: POSTPAID_BY_HOUR. |
| InstanceChargePrepaid | No | InstanceChargePrepaid | Configuration of prepaid instances. You can use the parameter to specify the attributes of prepaid instances, such as the subscription period and the auto-renewal plan. This parameter is required for prepaid instances. |
| Placement | No | Placement | Location of the instance. You can use this parameter to specify the attributes of the instance, such as its availability zone, project, and CDH. You can specify a CDH for a CVM by creating the CVM on the CDH. |
| InstanceType | No | String | The instance model. Different resource specifications are specified for different instance models.POSTPAID_BY_HOUR instances, you can call DescribeInstanceTypeConfigs or refer to Instance Types. If this parameter is not specified, S1.SMALL1 will be used by default.CDHPAID instances, the value of this parameter is in the format of CDH_XCXG based on the number of CPU cores and memory capacity. For example, if you want to create a CDH instance with a single-core CPU and 1 GB memory, specify this parameter as CDH_1C1G. |
| ImageId | No | String | The image ID in the format of img-xxx. There are four types of images:You can retrieve available image IDs in the following ways: public images, custom images, and shared images, log in to the console to query the information. For the IDs of marketplace images, go to Cloud Marketplace. InstanceType to retrieve the list of images supported by the current model, and then find the ImageId in the response. |
| SystemDisk | No | SystemDisk | System disk configuration of the instance. If this parameter is not specified, the default value will be used. |
| DataDisks.N | No | Array of DataDisk | The configuration information of instance data disks. If this parameter is not specified, no data disk will be purchased by default. When purchasing, you can specify 21 data disks, which can contain at most 1 LOCAL_BASIC data disk or LOCAL_SSD data disk, and at most 20 CLOUD_BASIC data disks, CLOUD_PREMIUM data disks, or CLOUD_SSD data disks. |
| VirtualPrivateCloud | No | VirtualPrivateCloud | Configuration information of VPC. This parameter is used to specify VPC ID and subnet ID, etc. If this parameter is not specified, the classic network is used by default. If a VPC IP is specified in this parameter, it indicates the primary ENI IP of each instance. The value of parameter InstanceCount must be same as the number of VPC IPs, which cannot be greater than 20. |
| InternetAccessible | No | InternetAccessible | Configuration of public network bandwidth. If this parameter is not specified, 0 Mbps will be used by default. |
| InstanceCount | No | Integer | The number of instances to be purchased. Value range: [1, 100]; default value: 1. The specified number of instances to be purchased cannot exceed the remaining quota allowed for the user. For more information on the quota, see CVM instance purchase limit. |
| InstanceName | No | String | Instance name to be displayed.{R:x}, numbers [x, x+n-1] will be generated, where n represents the number of instances purchased. For example, you specify a pattern string, server_{R:3}. If you only purchase 1 instance, the instance will be named server_3; if you purchase 2, they will be named server_3 and server_4. You can specify multiple pattern strings in the format of {R:x}.1, 2...n, where n represents the number of instances purchased. For example, if you purchase 2 instances and name them as server_, the instance names will be displayed as server_1 and server_2. |
| LoginSettings | No | LoginSettings | Login settings of the instance. You can use this parameter to set the login method, password, and key of the instance or keep the login settings of the original image. By default, a random password will be generated and sent to you via the Message Center. |
| SecurityGroupIds.N | No | Array of String | Security groups to which the instance belongs. To obtain the security group IDs, you can call DescribeSecurityGroups and look for the sgld fields in the response. If this parameter is not specified, the instance will be associated with default security groups. |
| EnhancedService | No | EnhancedService | Specifies whether to enable services such as Anti-DDoS and Cloud Monitor. If this parameter is not specified, Cloud Monitor and Anti-DDoS are enabled for public images by default. However, for custom images and images from the marketplace, Anti-DDoS and Cloud Monitor are not enabled by default. The original services in the image will be retained. |
| ClientToken | No | String | A string used to ensure the idempotency of the request, which is generated by the user and must be unique to each request. The maximum length is 64 ASCII characters. If this parameter is not specified, the idempotency of the request cannot be guaranteed. For more information, see 'How to ensure idempotency'. |
| HostName | No | String | Host name of the CVM. |
| ActionTimer | No | ActionTimer | Scheduled tasks. You can use this parameter to specify scheduled tasks for the instance. Only scheduled termination is supported. |
| DisasterRecoverGroupIds.N | No | Array of String | Placement group ID. You can only specify one. |
| TagSpecification.N | No | Array of TagSpecification | The tag description list. This parameter is used to bind a tag to a resource instance. A tag can only be bound to CVM instances. |
| InstanceMarketOptions | No | InstanceMarketOptionsRequest | The market options of the instance. |
| UserData | No | String | User data provided to the instance, which needs to be encoded in base64 format with the maximum size of 16KB. For more information on how to get the value of this parameter, see the commands you need to execute on startup for Windows or Linux. |
| DryRun | No | Boolean | Whether the request is a dry run only. true: dry run only. The request will not create instance(s). A dry run can check whether all the required parameters are specified, whether the request format is right, whether the request exceeds service limits, and whether the specified CVMs are available. If the dry run fails, the corresponding error code will be returned. If the dry run succeeds, the RequestId will be returned. false (default value): send a normal request and create instance(s) if all the requirements are met. |
| CamRoleName | No | String | CAM role name, which can be obtained from the roleName field in the response of the DescribeRoleList API. |
| HpcClusterId | No | String | HPC cluster ID. The HPC cluster must and can only be specified for a high-performance computing instance. |
| Parameter Name | Type | Description |
|---|---|---|
| InstanceIdSet | Array of String | If you use this API to create instance(s), this parameter will be returned, representing one or more instance IDs. Retuning the instance ID list does not necessarily mean that the instance(s) were created successfully. To check whether the instance(s) were created successfully, you can call DescribeInstances and check the states of the instances in InstancesSet in the response. If the state of an instance changes from "pending" to "running", it means that the instance has been created successfully. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to create an instance using only the required Placement.Zone and ImageId parameters. The other parameters use system default values. The instance is created in Shanghai Zone 2 with the image img-pmqg1cw7.
GET https://cvm.tencentcloudapi.com/?Action=RunInstances
&Placement.Zone=ap-shanghai-2
&ImageId=img-pmqg1cw7
&<Common request parameters>
{
"Response": {
"InstanceIdSet": [
"ins-1vogaxgk"
],
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}
This example shows you how to purchase one 64C256G standard (S5.16XLARGE256) instance in Shanghai Zone 2 using the image img-pmqg1cw7. The other configurations are as follows: billing method: monthly subscription for one month, with the auto-renewal enabled; system disk: 50 GB Premium Cloud Storage; data disk: 100 GB Premium Cloud Storage; network type: VPC; public network billing: pay-as-you-go by traffic on an hourly basis; public network bandwidth cap: 10 Mbps; public IP: randomly assigned; instance name: QCLOUD-TEST; login password: Qcloud@TestApi123++; Cloud Monitor service: enabled; Anti-DDoS: enabled.
GET https://cvm.tencentcloudapi.com/?Action=RunInstances
&Placement.Zone=ap-shanghai-2
&InstanceChargeType=PREPAID
&InstanceChargePrepaid.Period=1
&InstanceChargePrepaid.RenewFlag=NOTIFY_AND_AUTO_RENEW
&ImageId=img-pmqg1cw7
&InstanceType=S5.16XLARGE256
&SystemDisk.DiskType=CLOUD_PREMIUM
&SystemDisk.DiskSize=50
&DataDisks.0.DiskType=CLOUD_PREMIUM
&DataDisks.0.DiskSize=100
&InternetAccessible.InternetChargeType=TRAFFIC_POSTPAID_BY_HOUR
&InternetAccessible.InternetMaxBandwidthOut=10
&InternetAccessible.PublicIpAssigned=TRUE
&InstanceName=QCLOUD-TEST
&LoginSettings.Password=Qcloud@TestApi123++
&EnhancedService.SecurityService.Enabled=TRUE
&EnhancedService.MonitorService.Enabled=TRUE
&InstanceCount=1
&<Common request parameters>
{
"Response": {
"InstanceIdSet": [
"ins-bfw5zq3y"
],
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}
This example shows you how to purchase one 64C256G standard (S5.16XLARGE256) instance in Shanghai Zone 2 using the image img-pmqg1cw7. The other configurations are as follows: billing mode: pay-as-you-go on an hourly basis; system disk: 50 GB Premium Cloud Storage; data disk: 100 GB Premium Cloud Storage; network type: VPC; public network billing: pay-as-you-go by traffic on an hourly basis; public network bandwidth cap: 10 Mbps; public IP: randomly assigned; instance name: QCLOUD-TEST; login password: Qcloud@TestApi123++; Cloud Monitor service: enabled; Anti-DDoS: enabled.
GET https://cvm.tencentcloudapi.com/?Action=RunInstances
&Placement.Zone=ap-shanghai-2
&InstanceChargeType=POSTPAID_BY_HOUR
&ImageId=img-pmqg1cw7
&InstanceType=S5.16XLARGE256
&SystemDisk.DiskType=CLOUD_PREMIUM
&SystemDisk.DiskSize=50
&DataDisks.0.DiskType=CLOUD_PREMIUM
&DataDisks.0.DiskSize=100
&InternetAccessible.InternetChargeType=TRAFFIC_POSTPAID_BY_HOUR
&InternetAccessible.InternetMaxBandwidthOut=10
&InternetAccessible.PublicIpAssigned=TRUE
&InstanceName=QCLOUD-TEST
&LoginSettings.Password=Qcloud@TestApi123++
&EnhancedService.SecurityService.Enabled=TRUE
&EnhancedService.MonitorService.Enabled=TRUE
&InstanceCount=1
&<Common request parameters>
{
"Response": {
"InstanceIdSet": [
"ins-32kcaqoa"
],
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}
This example shows you how to purchase one instance with the following configurations. Availability zone: Shanghai Zone 2; CDH: host-q88gab4i; image ID: img-pmqg1cw7; billing method: billed together with the CDH; model: 1C1G; system disk: 50 GB Premium Cloud Storage; data disk: 100 GB Premium Cloud Storage; network type: VPC; public network billing: pay-as-you-go by traffic on an hourly basis; public network bandwidth cap: 10 Mbps; public IP: randomly assigned; instance name: QCLOUD-TEST; login password: Qcloud@TestApi123++; Cloud Monitor service: enabled; Anti-DDoS: enabled.
GET https://cvm.tencentcloudapi.com/?Action=RunInstances
&Placement.Zone=ap-shanghai-2
&Placement.HostIds.0=host-q88gab4i
&InstanceChargeType=CDHPAID
&ImageId=img-pmqg1cw7
&InstanceType=CDH_1C1G
&SystemDisk.DiskType=CLOUD_PREMIUM
&SystemDisk.DiskSize=50
&DataDisks.0.DiskType=CLOUD_PREMIUM
&DataDisks.0.DiskSize=100
&InternetAccessible.InternetChargeType=TRAFFIC_POSTPAID_BY_HOUR
&InternetAccessible.InternetMaxBandwidthOut=10
&InternetAccessible.PublicIpAssigned=TRUE
&InstanceName=QCLOUD-TEST
&LoginSettings.Password=Qcloud@TestApi123++
&EnhancedService.SecurityService.Enabled=TRUE
&EnhancedService.MonitorService.Enabled=TRUE
&InstanceCount=1
&<Common request parameters>
{
"Response": {
"InstanceIdSet": [
"ins-0s7wsh5x"
],
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}
This example shows you how to purchase two instances with the following configurations. Availability zone: Shanghai Zone 2; billing method: pay-as-you-go on an hourly basis; image ID: img-dkwyg6sr; model: 64C256G standard (S5.16XLARGE256); system disk: 50 GB Premium Cloud Storage; network: VPC; VPC ID: 1urkhbj4; subnet ID: dcs9x3gz; VPC IP address: 10.0.0.18 and 10.0.0.19.
GET https://cvm.tencentcloudapi.com/?Action=RunInstances
&InstanceType=S5.16XLARGE256
&SystemDisk.DiskType=CLOUD_PREMIUM
&SystemDisk.DiskSize=50
&Placement.Zone=ap-shanghai-2
&ImageId=img-dkwyg6sr
&VirtualPrivateCloud.SubnetId=subnet-dcs9x3gz
&VirtualPrivateCloud.VpcId=vpc-1urkhbj4
&VirtualPrivateCloud.PrivateIpAddresses.0=10.0.0.18
&VirtualPrivateCloud.PrivateIpAddresses.1=10.0.0.19
&InstanceCount=2
&<Common request parameters>
{
"Response": {
"InstanceIdSet": [
"ins-0s7wsh5x",
"ins-03lw8hok"
],
"RequestId": "3c14def19-cfes-470e-b241-90787u6jf5uj"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AccountQualificationRestrictions | Your account failed the qualification verification. |
| AuthFailure.CamRoleNameAuthenticateFailed | Role name authentication failed. |
| FailedOperation.DisasterRecoverGroupNotFound | The specified spread placement group does not exist. |
| FailedOperation.InquiryPriceFailed | Price query failed. |
| FailedOperation.SecurityGroupActionFailed | Security group operation failed. |
| FailedOperation.SnapshotSizeLessThanDataSize | The snapshot size should be larger than the cloud disk capacity. |
| FailedOperation.TagKeyReserved | The tag key specified in the request is reserved for the system. |
| InstancesQuotaLimitExceeded | You are trying to create more instances than your remaining quota allows. |
| InternalError.TradeUnknownError | Internal error. |
| InvalidAccount.InsufficientBalance | Insufficient account balance. |
| InvalidClientToken.TooLong | The specified ClientToken exceeds the maximum length of 64 bytes. |
| InvalidHostId.Malformed | Invalid CDH ID. The specified CDH ID has an invalid format. For example, host-1122 has an invalid ID length. |
| InvalidHostId.NotFound | The specified HostId does not exist, or does not belong to your account. |
| InvalidImageId.Malformed | Invalid image ID format. |
| InvalidImageId.NotFound | The image cannot be found. |
| InvalidInstanceName.TooLong | The specified InstanceName exceeds the maximum length of 60 bytes. |
| InvalidInstanceType.Malformed | The specified InstanceType parameter has an invalid format. |
| InvalidParameter.InstanceImageNotSupport | This API does not support instance images. |
| InvalidParameter.InvalidIpFormat | Invalid VPC IP address format. |
| InvalidParameter.LackCoreCountOrThreadPerCore | CoreCount and ThreadPerCore must be specified at the same time. |
| InvalidParameter.ParameterConflict | Specifying an SSH key will override the original one of the image. |
| InvalidParameter.SnapshotNotFound | The specified snapshot does not exist. |
| InvalidParameterCombination | The parameter combination is invalid. |
| InvalidParameterValue | Incorrect parameter value. |
| InvalidParameterValue.BandwidthPackageIdNotFound | |
| InvalidParameterValue.CloudSsdDataDiskSizeTooSmall | The minimum capacity of a SSD data disk is 100 GB. |
| InvalidParameterValue.CoreCountValue | Illegal core count. |
| InvalidParameterValue.Duplicate | |
| InvalidParameterValue.IllegalHostName | The value of HostName is invalid. |
| InvalidParameterValue.InstanceTypeNotSupportHpcCluster | This type of instances cannot be added to the HPC cluster. |
| InvalidParameterValue.InstanceTypeRequiredHpcCluster | The HPC cluster needs to be specified for the high-performance computing instance. |
| InvalidParameterValue.InsufficientOffering | The spot instance is out of stock. |
| InvalidParameterValue.InsufficientPrice | The bid is lower than the market price. |
| InvalidParameterValue.InvalidImageState | Invalid image status. |
| InvalidParameterValue.InvalidIpFormat | Invalid IP address. |
| InvalidParameterValue.InvalidTimeFormat | Incorrect time format. |
| InvalidParameterValue.InvalidUserDataFormat | Incorrect UserData format. Use the Base64-encoded format. |
| InvalidParameterValue.KeyPairNotFound | |
| InvalidParameterValue.LaunchTemplateIdNotExisted | The instance launch template ID does not exist. |
| InvalidParameterValue.LimitExceeded | The number of parameter values exceeds the limit. |
| InvalidParameterValue.MustDhcpEnabledVpc | The parameter value must be a DHCP-enabled VPC. |
| InvalidParameterValue.Range | Invalid parameter value: invalid parameter value range. |
| InvalidParameterValue.SnapshotIdMalformed | Invalid snapshot ID. Provide a snapshot ID in the format of snap-xxxxxxxx, where the letter x refers to lowercase letter or number. |
| InvalidParameterValue.SubnetNotExist | Creation failed: the subnet does not exist. Please specify another subnet. |
| InvalidParameterValue.ThreadPerCoreValue | Invalid thread count per core. |
| InvalidParameterValue.VpcIdZoneIdNotMatch | The VPC and instance must be in the same availability zone. |
| InvalidParameterValue.ZoneNotSupported | The availability zone does not support this operation. |
| InvalidPassword | Invalid password. The specified password does not meet the password requirements. For example, the password length does not meet the requirements. |
| InvalidPeriod | Invalid period. Valid values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36]; unit: month. |
| InvalidPermission | This operation is not supported for the account. |
| InvalidProjectId.NotFound | Invalid project ID: the specified project ID does not exist. |
| InvalidSecurityGroupId.NotFound | The specified security group ID does not exist. |
| InvalidZone.MismatchRegion | The specified zone does not exist. |
| LimitExceeded.CvmsVifsPerSecGroupLimitExceeded | The CVM ENIs associated with the security group has exceeded the limit. |
| LimitExceeded.InstanceQuota | You are short of the instance quota. |
| LimitExceeded.SingleUSGQuota | The number of security groups exceeds the quota limit. |
| LimitExceeded.SpotQuota | The spot instance offerings are out of stock. |
| LimitExceeded.UserSpotQuota | You are short of the spot instance quota. |
| LimitExceeded.VpcSubnetNum | Insufficient subnet IPs. |
| MissingParameter | Missing parameter. |
| MissingParameter.DPDKInstanceTypeRequiredVPC | The DPDK instance requires a VPC. |
| MissingParameter.MonitorService | The instance type must have Cloud Monitor enabled. |
| ResourceInsufficient.AvailabilityZoneSoldOut | The availability zone has been sold out. |
| ResourceInsufficient.CloudDiskSoldOut | The specified cloud disk has been sold out. |
| ResourceInsufficient.CloudDiskUnavailable | The parameters of cloud disk do not meet the specification. |
| ResourceInsufficient.DisasterRecoverGroupCvmQuota | The number of instances exceeded the quota limit of spread placement groups. |
| ResourceInsufficient.SpecifiedInstanceType | The specified instance type is insufficient. |
| ResourceNotFound.HpcCluster | The HPC cluster does not exist. |
| ResourceNotFound.NoDefaultCbs | No default CBS resources are available. |
| ResourceNotFound.NoDefaultCbsWithReason | No default CBS resources are available. |
| ResourceUnavailable.InstanceType | This instance type is unavailable in the availability zone. |
| ResourcesSoldOut.EipInsufficient | The public IP has been sold out. |
| ResourcesSoldOut.SpecifiedInstanceType | The specified instance type is sold out. |
| UnsupportedOperation.BandwidthPackageIdNotSupported | The specified instance or network cannot use the bandwidth package. |
| UnsupportedOperation.InstanceStateIsolating | Unable to isolate: the instance is isolated |
| UnsupportedOperation.InvalidDisk | The specified disk is not supported. |
| UnsupportedOperation.KeyPairUnsupportedWindows | Key-pair login is not available to Windows instances. |
| UnsupportedOperation.NoInstanceTypeSupportSpot | This instance type does not support spot instances. |
| UnsupportedOperation.OnlyForPrepaidAccount | Only a prepaid account supports this operation. |
| UnsupportedOperation.UnsupportedInternationalUser | A Tencent Cloud International account does not support this operation. |
| VpcAddrNotInSubNet | The VPC IP address is not in the subnet. |
| VpcIpIsUsed | The VPC IP address is already occupied. |
Was this page helpful?