tencent cloud

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 status 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. 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 Quota for CVM Instances. Instances created through this API and in the CVM console are counted toward the quota.
• This API is an async API. An instance ID list is returned after the creation request is sent. However, it does not mean the creation has been completed. The status 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.

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 Purchasing a CDH Instance

This example shows you how to purchase 1 instance with the following configurations. Availability zone: Shanghai Zone 2; CDH: host-q88gab4i; billing mode: billed by CDH instance; image ID: img-pmqg1cw7; model: 1C1G; system disk: 50 GB premium cloud disk; data disk: 100 GB premium cloud disk; network type: VPC; public network billing: pay-as-you-go by traffic on an hourly basis; public network bandwidth cap: 10 Mbps; public IP address: randomly allocated; instance name: QCLOUD-TEST; login password: Qcloud@TestApi123++; Cloud Monitor: enabled; Cloud Security: enabled.

Input Example

POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RunInstances
<Common request parameters>



{
    "SystemDisk": {
        "DiskSize": "50",
        "DiskType": "CLOUD_PREMIUM"
    },
    "InstanceCount": "1",
    "Placement": {
        "HostIds": [
            "host-q88gab4i"
        ],
        "Zone": "ap-shanghai-2"
    },
    "LoginSettings": {
        "Password": "Qcloud@TestApi123++"
    },
    "ImageId": "img-pmqg1cw7",
    "InstanceChargeType": "CDHPAID",
    "EnhancedService": {
        "SecurityService": {
            "Enabled": "TRUE"
        },
        "MonitorService": {
            "Enabled": "TRUE"
        }
    },
    "InternetAccessible": {
        "PublicIpAssigned": "TRUE",
        "InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
        "InternetMaxBandwidthOut": "10"
    },
    "InstanceName": "QCLOUD-TEST",
    "InstanceType": "CDH_1C1G",
    "DataDisks": [
        {
            "DiskSize": "100",
            "DiskType": "CLOUD_PREMIUM"
        }
    ]
}

Output Example

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

Example2 Purchasing a Monthly Subscription Instance

This example shows you how to purchase 1 instance with the following configurations. Availability zone: Shanghai Zone 2; billing mode: monthly subscription for 1 month, with auto-renewal enabled; image ID: img-pmqg1cw7; model: 64C256G standard (S5.16XLARGE256); system disk: 50 GB premium cloud disk; data disk: 100 GB premium cloud disk; network type: VPC; public network billing: pay-as-you-go by traffic on an hourly basis; public network bandwidth cap: 10 Mbps; public IP address: randomly allocated; instance name: QCLOUD-TEST; login password: Qcloud@TestApi123++; Cloud Monitor: enabled; Cloud Security: enabled.

Input Example

POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RunInstances
<Common request parameters>



{
    "SystemDisk": {
        "DiskSize": "50",
        "DiskType": "CLOUD_PREMIUM"
    },
    "InstanceCount": "1",
    "Placement": {
        "Zone": "ap-shanghai-2"
    },
    "LoginSettings": {
        "Password": "Qcloud@TestApi123++"
    },
    "ImageId": "img-pmqg1cw7",
    "InstanceChargeType": "PREPAID",
    "EnhancedService": {
        "SecurityService": {
            "Enabled": "TRUE"
        },
        "MonitorService": {
            "Enabled": "TRUE"
        }
    },
    "InternetAccessible": {
        "PublicIpAssigned": "TRUE",
        "InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
        "InternetMaxBandwidthOut": "10"
    },
    "InstanceChargePrepaid": {
        "RenewFlag": "NOTIFY_AND_AUTO_RENEW",
        "Period": "1"
    },
    "InstanceName": "QCLOUD-TEST",
    "InstanceType": "S5.16XLARGE256",
    "DataDisks": [
        {
            "DiskSize": "100",
            "DiskType": "CLOUD_PREMIUM"
        }
    ]
}

Output Example

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

Example3 Purchasing an Instance with Only Required Parameters

This example shows you how to purchase an instance in Shanghai Zone 2 with the image ID img-pmqg1cw7. Only the required Placement.Zone and ImageId parameters are provided. The other parameters use system default values.

Input Example

POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RunInstances
<Common request parameters>



{
    "Placement": {
        "Zone": "ap-shanghai-2"
    },
    "ImageId": "img-pmqg1cw7"
}

Output Example

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

Example4 Purchasing an Hourly-Billed Pay-as-You-Go Instance

This example shows you how to purchase 1 instance with the following configurations. Availability zone: Shanghai Zone 2; billing mode: pay-as-you-go on an hourly basis; image ID: img-pmqg1cw7; model: 64C256G standard (S5.16XLARGE256); system disk: 50 GB premium cloud disk; data disk: 100 GB premium cloud disk; network type: VPC; public network billing: pay-as-you-go by traffic on an hourly basis; public network bandwidth cap: 10 Mbps; public IP address: randomly allocated; instance name: QCLOUD-TEST; login password: Qcloud@TestApi123++; Cloud Monitor: enabled; Cloud Security: enabled.

Input Example

POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RunInstances
<Common request parameters>



{
    "SystemDisk": {
        "DiskSize": "50",
        "DiskType": "CLOUD_PREMIUM"
    },
    "InstanceCount": "1",
    "Placement": {
        "Zone": "ap-shanghai-2"
    },
    "LoginSettings": {
        "Password": "Qcloud@TestApi123++"
    },
    "ImageId": "img-pmqg1cw7",
    "InstanceChargeType": "POSTPAID_BY_HOUR",
    "EnhancedService": {
        "SecurityService": {
            "Enabled": "TRUE"
        },
        "MonitorService": {
            "Enabled": "TRUE"
        }
    },
    "InternetAccessible": {
        "PublicIpAssigned": "TRUE",
        "InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
        "InternetMaxBandwidthOut": "10"
    },
    "InstanceName": "QCLOUD-TEST",
    "InstanceType": "S5.16XLARGE256",
    "DataDisks": [
        {
            "DiskSize": "100",
            "DiskType": "CLOUD_PREMIUM"
        }
    ]
}

Output Example

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

Example5 Creating an Instance with the Private IP Address Specified

This example shows you how to purchase 2 instances with the following configurations. Availability zone: Shanghai Zone 2; billing mode: pay-as-you-go on an hourly basis; image ID: img-dkwyg6sr; model: 64C256G standard (S5.16XLARGE256); system disk: 50 GB premium cloud disk; network type: VPC; VPC ID: 1urkhbj4; subnet ID: dcs9x3gz; private IP address: 10.0.0.18 and 10.0.0.19.

Input Example

POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RunInstances
<Common request parameters>



{
    "VirtualPrivateCloud": {
        "SubnetId": "subnet-dcs9x3gz",
        "VpcId": "vpc-1urkhbj4",
        "PrivateIpAddresses": [
            "10.0.0.19",
            "10.0.0.18"
        ]
    },
    "InstanceCount": "2",
    "Placement": {
        "Zone": "ap-shanghai-2"
    },
    "SystemDisk": {
        "DiskSize": "50",
        "DiskType": "CLOUD_PREMIUM"
    },
    "ImageId": "img-dkwyg6sr",
    "InstanceType": "S5.16XLARGE256"
}

Output Example

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

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for Node.js
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

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