RunInstances

1. API Description

Domain name for API request: cvm.tencentcloudapi.com.

This API is used to create one or more instances with a specified configuration.

• After an instance is created successfully, it will start up automatically, and the instance state will become "Running".
• If you create a pay-as-you-go instance billed on an hourly basis, an amount equivalent to the hourly rate will be frozen before the creation. Make sure your account balance is sufficient before calling this API.
• The number of instances you can purchase through this API is subject to the CVM instance purchase limit. Both the instances created through this API and the console will be counted toward the quota.
• This API is an async API. An instance 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

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

3. Output Parameters

4. Example

Example1 Creating an instance with the fewest parameters specified

This example shows you how to create an instance in Guangzhou Zone 2 from the image whose image ID is img-pmqg1cw7. In the example, only the two required parameters, namely Placement.Zone and ImageId, are specified. Default values are used for the other parameters.

Input Example

GET https://cvm.tencentcloudapi.com/?Action=RunInstances
&Placement.Zone=ap-guangzhou-2
&ImageId=img-pmqg1cw7
&<Common request parameters>

Output Example

{
  "Response": {
    "InstanceIdSet": [
      "ins-1vogaxgk"
    ],
    "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
  }
}

Example2 Purchasing a pay-as-you-go instance billed on an hourly basis

In this example, the instance has the following configurations. Availability zone: Guangzhou Zone 2; billing method: hourly, pay-as-you-go; image ID: img-pmqg1cw7; model: S2.SMALL1 (Standard S1, 1-core, 1 GB); system disk: 50 GB basic local disk; data disk: 100 GB basic local disk; network: basic network; public network billing method: bill-by-traffic, hourly, pay-as-you-go; maximum public network bandwidth: 10 Mbps; public IP address: assigned; instance name: QCLOUD-TEST; login password: Qcloud@TestApi123++; Cloud Monitor service: enabled; Cloud Security service: enabled; quantity: 1.

Input Example

GET https://cvm.tencentcloudapi.com/?Action=RunInstances
&Placement.Zone=ap-guangzhou-2
&InstanceChargeType=POSTPAID_BY_HOUR
&ImageId=img-pmqg1cw7
&SystemDisk.DiskType=LOCAL_BASIC
&SystemDisk.DiskSize=50
&DataDisks.0.DiskType=LOCAL_BASIC
&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
&<Common request parameters>

Output Example

{
  "Response": {
    "InstanceIdSet": [
      "ins-32kcaqoa"
    ],
    "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
  }
}

Example3 Purchase a dedicated CVM

In this example, the dedicated CVM instance has the following configurations. Availability zone: Guangzhou Zone 2; CDH ID: host-q88gab4i; billing method: billed by dedicated CVMs; image ID: img-pmqg1cw7; model: 1-core, 1 GB; system disk: 50 GB basic local disk; data disk: 100 GB basic local disk; network: basic network; public network billing method: bill-by-traffic, hourly, pay-as-you-go; maximum public network bandwidth: 10 Mbps; public IP address: assigned; instance name: QCLOUD-TEST; login password: Qcloud@TestApi123++; Cloud Monitor service: enabled; Cloud Security service: enabled; quantity: 1.

Input Example

GET https://cvm.tencentcloudapi.com/?Action=RunInstances
&Placement.Zone=ap-guangzhou-2
&Placement.HostIds.0=host-q88gab4i
&InstanceChargeType=CDHPAID
&ImageId=img-pmqg1cw7
&SystemDisk.DiskType=LOCAL_BASIC
&SystemDisk.DiskSize=50
&DataDisks.0.DiskType=LOCAL_BASIC
&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
&<Common request parameters>

Output Example

{
  "Response": {
    "InstanceIdSet": [
      "ins-0s7wsh5x"
    ],
    "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
  }
}

Example4 Creating an instance with the VPC IP specified

In this example, the instance has the following configurations. Availability zone: Hong Kong Zone 1; billing method: hourly, pay-as-you-go; image ID: img-dkwyg6sr; model: S1.SMALL1 (Standard S1, 1-core, 1 GB); system disk: 50 GB basic local disk; network: VPC; VPC ID: 1urkhbj4; subnet ID: dcs9x3gz; VPC IP: 10.0.0.18, 10.0.0.19; quantity: 2.

Input Example

GET https://cvm.tencentcloudapi.com/?Action=RunInstances
&SystemDisk.DiskType=CLOUD_BASIC
&SystemDisk.DiskSize=50
&Placement.Zone=ap-hongkong-1
&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
&<Common request parameters>

Output Example

{
  "Response": {
    "InstanceIdSet": [
      "ins-0s7wsh5x",
      "ins-03lw8hok"
    ],
    "RequestId": "3c14def19-cfes-470e-b241-90787u6jf5uj"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

• API 3.0 Explorer

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.