Precondition

The creation of instances requires identity authentication. If you failing to pass the identity authentication, you can go to the Individual Authentication or Enterprise Authentication in the console of the official website of Baidu AI Cloud for authentication.

BCC instance

• Billing precautions:

  • The instance with the billing mode of postpaid as created requires that the sum of cash balance of the account plus the general voucher is greater than 100; the instance of pre-paid mode requires that the cash balance of the account is greater than or equal to the instance costs.
  • For the creation of the specified public network IP bandwidth, the charging mode is charging according to the bandwidth.

• Instance precautions:

  • Specify the virtual machine type to be created according to the spec field, and view the available instance package and the package specification by the package specification list interface. 。
  • We can't purchase GPU card and FPGA card simultaneously for the same instance. We must specify the number of GPU cards or FPGA cards carried by virtual machines to be purchased by cardCount when purchasing the instances with GPU card or FPGA card.

• Storage precautions:

  • When creating an instance, we can specify the size of system disk, and the size scope of the specified system disk is [40,500] GB. The free 40GB CDS of hp1 type is used as the system disk by default. For the system disk types you can specify, please refer to StorageType.
  • Baidu AI Cloud offers a 40GB system disk for free. The fees are charged according to the corresponding CDS cloud disk when the free 40GB limit is exceeded.
  • The system disk added in instance creation can't be changed after creation. The separate creation or addition of system disks is not supported.
  • The system disk doesn't support mounting, unloading and deletion.
  • In the creation of CDS system disk and data disk, the selection of disk size according to 1GB step size is supported.
  • By default, one instance can mount a maximum of 5 cloud disks.
  • The maximum size of the system disk of BCC instance can't exceed 500G.
  • One temporary data disk can be purchased only for each instance. The type of temporary data disk is hp1 only by default.
  • When creating the storage optimization instances, we must purchase temporary data disks, and specify the temporary data disk size by ephemeralDisks. The default disk is the data disk of nvme type and may not be specified.

• Network precautions:

  • The BCC instance supports custom security group and subnet. The custom security group and subnet should be specified under the same VPC simultaneously. If the security group and subnet are not specified, the created exclusive instance are automatically added in the default security group and subnet in the system.

• Other precautions:

  • The batch creation is supported. And if the creation of one instance fails in the creation process, all the instances are rolled back and their creation fails. And the instances are also rolled back if CDS and CDS are included in the creation.
  • The interface is created asynchronously. You can query the instance status by the Query Specified Instance Details interface.

Request

Request structure

POST /v{version}/instanceBySpec?clientToken={clientToken} HTTP/1.1 
Host: bcc.bj.baidubce.com 
Authorization: authorization string 

{ 
    "spec": spec, 
    "rootDiskSizeInGb":rootDiskSizeInGb, 
    "rootDiskStorageType":"rootDiskStorageType", 
    "ephemeralDisks": [ 
        { 
            "storageType": storageType, 
            "sizeInGB": size 
        }, 
        { 
            "storageType": storageType, 
            "sizeInGB": size 
        } 
    ], 
    "createCdsList": [ 
        { 
            "storageType": storageType, 
            "cdsSizeInGB": cdsSizeInGB, 
            "snapshotId": snapshotId 
        } 
    ], 
    "name": "name", 
    "imageId": "imageId", 
    "networkCapacityInMbps": networkCapacityInMbps, 
    "autoRenewTimeUnit": "autoRenewTimeUnit", 
    "autoRenewTime": autoRenewTime, 
    "cdsAutoRenew": cdsAutoRenew, 
    "internetChargeType": internetChargeType, 
    "dedicatedHostId": dedicatedHostId, 
    "purchaseCount": purchaseCount, 
    "billing":{ 
        "paymentTiming": paymentTiming, 
        "reservation": { 
            "reservationLength": reservationLength 
        } 
    }, 
    "zoneName": zoneName, 
    "subnetId": subnetId, 
    "securityGroupId": securityGroupId, 
    "relationTag": relationTag, 
    "tags": [ 
       { 
          "tagKey": tagKey, 
          "tagValue": tagValue 
       } 
    ], 
    "keypairId": keypairId 
} 

Request header

There are no special headers except the common header.

Request parameter

Return

Return header

There are no special headers except the common header.

Return parameter

Error code

Example

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

POST /v2/instanceBySpec?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1 
Host: bcc.bj.baidubce.com 
ContentType: application/json    
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de 

{ 
    "spec": "bcc.g3.c4m12", 
    "createCdsList": [ 
        { 
            "storageType": "std1", 
            "cdsSizeInGB": 5 
        } 
    ], 
    "name": "example", 
    "imageId": "m-mRjO3cjs", 
    "networkCapacityInMbps": 0, 
    "purchaseCount": 1, 
    "billing":{ 
        "paymentTiming":"Prepaid", 
        "reservation": { 
            "reservationLength": 1 
        } 
    } 
} 

Return example

HTTP/1.1 200 OK 
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT 
Content-Type: application/json;charset=UTF-8 
Server: BWS 

{ 
    "instanceIds": [ 
        "i-T1I3OtUO"
    ] 
}