Create instance

Prerequisites

Creating an instance requires real-name certification. Users who have not completed real-name certification can proceed to the Personal Certification or Enterprise Certification sections under Security Certification in the Baidu AI Cloud’s console for certification.

BCC instances

• Notes for billing:

  • To create a postpaid instance, the account's cash balance combined with general coupons must exceed 100. For prepaid instances, the account's cash balance must at least match the cost of the instance.
  • Specify the public IP bandwidth during creation, with charges based on the selected bandwidth.

• Notes for instances:

  • Determine the virtual machine type to be created using the spec field. Use the instance package specification list API to view available instance packages and their specifications.
  • A single instance cannot simultaneously include both GPU and FPGA cards. When purchasing an instance with GPU or FPGA cards, specify the number of these cards to be included via the cardCount field.

• Notes for storage:

  • When creating an instance, you can specify the system disk size within the range of [40 to 500] GB. For available system disk types, refer to [StorageType](BCC/API Reference/Appendix.md#StorageType).
  • The system disk added during instance creation is fixed and cannot be modified afterward. It also cannot be created or added separately.
  • The system disk cannot be attached, detached, or deleted.
  • When creating CDS system disks and data disks, disk sizes can be chosen in 1 GB increments.
  • By default, an instance can attach up to five cloud disk servers.
  • The system disk of a BCC instance cannot exceed 500 GB in size.
  • Each instance can purchase only one temporary data disk, which defaults to the hp1 type.
  • When creating a storage-optimized instance, a temporary data disk is mandatory. Specify the size of the temporary data disk through the ephemeralDisks field; the default is an NVMe-type data disk, and no value needs to be provided.

• Notes for network:

  • BCC instances support user-defined security groups and subnets, both of which must be specified within the same VPC. If no security group or subnet is provided, the instance will automatically join the system's default security group and subnet when creating a dedicated instance.

• Other notes:

  • Batch creation is supported. If any instance fails during batch creation, all instances will be rolled back, resulting in no successful creations. If CDS is included in the creation, it will also be rolled back.
  • The creation API is asynchronous. Instance status can be queried using the [Query Specified Instance Details](BCC/API Reference/Instance Related Interfaces/Query the details of a specified instance.md) API.

Request

Request structure

1POST /v{version}/instanceBySpec?clientToken={clientToken} HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
4
5{
6    "spec": spec,
7    "rootDiskSizeInGb":rootDiskSizeInGb,
8    "rootDiskStorageType":"rootDiskStorageType",
9    "adminPass": "adminPass",
10    "ephemeralDisks": [
11        {
12            "storageType": storageType,
13            "sizeInGB": size
14        },
15        {
16            "storageType": storageType,
17            "sizeInGB": size
18        }
19    ],
20    "createCdsList": [
21        {
22            "storageType": storageType,
23            "cdsSizeInGB": cdsSizeInGB,
24            "snapshotId": snapshotId
25        }
26    ],
27    "name": "name",
28    "hostname": "hostname",
29    "autoSeqSuffix": autoSeqSuffix,
30    "isOpenHostnameDomain": isOpenHostnameDomain,
31    "imageId": "imageId",
32    "networkCapacityInMbps": networkCapacityInMbps,
33    "eipName": "eipName",
34    "autoRenewTimeUnit": "autoRenewTimeUnit",
35    "autoRenewTime": autoRenewTime,
36    "internetChargeType": internetChargeType,
37    "dedicatedHostId": dedicatedHostId,
38    "purchaseCount": purchaseCount,
39    "billing":{
40        "paymentTiming": paymentTiming,
41        "reservation": {
42            "reservationLength": reservationLength
43        }
44    },
45    "zoneName": zoneName,
46    "subnetId": subnetId,
47    "securityGroupId": securityGroupId,
48    "relationTag": relationTag,
49    "isOpenIpv6": isOpenIpv6,
50    "tags": [
51       {
52          "tagKey": tagKey,
53          "tagValue": tagValue
54       }
55    ],
56    "userData": "",
57    "keypairId": keypairId,
58    "aspId": "aspId",
59    "specId": "specId",
60    "resGroupId": "resGroupId",
61    "ehcClusterId": "ehcClusterId"
62}

Request headers

There are no special headers required beyond the common headers.

Request parameters

Response

Response headers

No special headers are required beyond the standard ones.

Response parameters

Error codes

Example

Request example (creating an instance by specifying the instance package specification spec)

1POST /v2/instanceBySpec?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2Host: bcc.bj.baidubce.com
3ContentType: application/json    
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6{
7    "spec": "bcc.g3.c4m12",
8    "createCdsList": [
9        {
10            "storageType": "std1",
11            "cdsSizeInGB": 5
12        }
13    ],
14    "name": "example",
15    "imageId": "m-mRjO3cjs",
16    "networkCapacityInMbps": 0,
17    "purchaseCount": 1,
18    "billing":{
19        "paymentTiming":"Prepaid",
20        "reservation": {
21            "reservationLength": 1
22        }
23    }
24}

Response example

1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7{
8    "instanceIds": [
9        "i-T1I3OtUO"
10    ],
11    "warningList": [
12        "warning info"
13    ]
14}