Precondition

Creating an instance requires the real name authentication. Anyone who does not pass the real name authentication can go to the [Personal Authentication](#UserGuide/Identity Verification/Individual Identity Verification.md) or [Enterprise Authentication](#UserGuide/Identity Verification/Enterprise Identity Verification.md) under the security authentication in the Baidu AI Cloud official website console for the authentication.

BCC instance

• Considerations for billing:

  • To create a postpaid instance, the account cash balance and the general voucher must be greater than 100 CNY. To create a prepaid instance, the account cash balance must be greater than or equal to the instance cost.
  • When you create the public IP with specified bandwidth, the billing mode is bill-by-bandwidth.

• Considerations for instance:

  • Specify the virtual machine type to create through the instanceType field. For the virtual machine types supported by API currently, see [InstanceType](#BCC/API Reference/Appendix.md#InstanceType). The parameters instanceType, cpuCount and memoryCapacityInGB can determine the required model and configuration.
  • You can not purchase both GPU card and FPGA card for the same instance. When you purchase an instance with GPU card or FPGA card, you must specify the number of GPU cards or FPGA cards for the virtual machine to purchase through cardCount.
  • When you purchase the virtual machine with GPU card or FPGA card, the number of CPU cores (cpuCount), memory capacity (memoryCapacityInGB), system disk type and size (ephemeralDisks) to purchase in the request should be empty or meet the requirements of [GPU BCC Optional Specification Configuration](#BCC/API Reference/Appendix.md#GPU BCC Optional Specification Configuration) or [FPGA BCC](#BCC/API Reference/Appendix.md#FPGA BCC Optional Specification Configuration) [Optional Specification Configuration of ](#BCC/APIReference/Appendix.md#FPGA BCC Optional Specification Configuration)depending on the number and type of GPU cards or FPGA cards.

• Considerations for storage:

  • When you create an instance, you can specify the system disk size. The system disk size range is [40, 500] GB. The 40 GB of free hp1 type CDS disk is used as the system disk by default. For the specified system disk type, see [StorageType](#BCC/API Reference/Appendix.md#StorageType).
  • Baidu AI Cloud provides 40 GB of free system disk. If it exceeds 40 GB of free quota, the excess part is charged as per corresponding CDS disk.
  • The system disk added during the creation of instance can not be changed after the creation, and it does not support to create or add the system disk separately.
  • The system disk does not support the mount, uninstall or delete.
  • When you create the CDS system disk and data disk, it supports to select the disk size at the step width 1 GB.
  • An instance can mount up to 5 CDS disks by default.
  • The system disk size of BCC instance can not exceed up to 500 GB.
  • You can purchase one temporary data disk for each instance at most. Only the hp1 type of temporary data disk exists by default.
  • To create a memory optimized instance, you must purchase the temporary data disk, and specify the storage capacity of the temporary data disk through ephemeralDisks. The temporary data disk is of nvme type by default, which does not need to specify.

• Considerations for network:

  • BCC instances support user-defined security groups and subnets, both of which need to be specified under the same VPC If you do not specify a security group and subnet, you will automatically enter the system's default security group and subnet when you create a dedicated instance.

• Other Precautions

  • Batch creation is supported, and if one instance fails to be created in the creation, all instances are rolled back and all creations fail. If a CDS is included when it is created, the CDS will also be rolled back.
  • If the interface is asynchronously created, the instance status can be queried via the [Designated Instance Details Interface](#BCC/API Instance Related Interface/Query the details of Designated Instances.md).
  • You can specify DCC to create an instance by this interface, and the dedicated instance is not billed. Dedicated instances can only create temporary disks and specify disk types by ephemeralDisks.

DCC Instance

This API is also used to create the instance on DCC. The following operations may be related to your business during the creation of DCC instance:

• The dedicated instance cannot be renewed.
• This API is used to create one or more dedicated instances.
• Batch creation is supported, and if one instance fails to be created in the creation, all instances are rolled back and all creations fail. If a CDS is included when it is created, the CDS will also be rolled back.
• The dedicated instance support creating and adding local disks.
• The local disk does not support the mount, uninstall or delete.
• DCC allows users to customize the parameters such as the CPU and memory of the dedicated instance. The resources of the dedicated instance created will use DCC resources.
• The dedicated instance can only creates temporary disks and specify disk types by ephemeralDisks.
• The dedicated instance support user-defined security groups and subnets, both of which need to be specified under the same VPC If you failed to specify any security group and subnets, when a dedicated instance is created, the default security group and subnet are added automatically by the system.

Request Structure

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

{
    "instanceType": instanceType,
    "cpuCount": cpuCoreCount,
    "memoryCapacityInGB": memoryCapacityInGB,
    “rootDiskSizeInGb":rootDiskSizeInGb,
    "rootDiskStorageType":"rootDiskStorageType",
    "ephemeralDisks": [
    {
        "storageType": storageType,
        "sizeInGB": size
    },
    {
        "storageType": storageType,
        "sizeInGB": size
    }
    ],
    "createCdsList": [
        {
            "storageType": storageType,
            "cdsSizeInGB": cdsSizeInGB
        }
    ],
    "name": "name",
    "hostname": "hostname",
    "autoSeqSuffix": autoSeqSuffix,
    "isOpenHostnameDomain": isOpenHostnameDomain,
    "imageId": "imageId",
    "localDiskSizeInGB": localDiskSizeInGB,
    "networkCapacityInMbps": networkCapacityInMbps,
    "autoRenewTimeUnit": "autoRenewTimeUnit",
    "autoRenewTime": autoRenewTime,
    "cdsAutoRenew": cdsAutoRenew,
	"dedicatedHostId": dedicatedHostId,
    "purchaseCount": purchaseCount,
    "billing":{
        "paymentTiming": paymentTiming,
		"reservation": {
        	"reservationLength": reservationLength
    	}
    },
	"zoneName": zoneName,
	"subnetId": subnetId,
	"securityGroupId": securityGroupId,
    "relationTag": relationTag,
    "isOpenIpv6": isOpenIpv6,
    "tags": [
       {
          "tagKey": tagKey,
          "tagValue": tagValue
       } 
    ],
    "keypairId": keypairId
}

Request header field

No other special header fields are available, except for common header fields.

Request Parameter

Return a header field

There are no other special header fields except the common header field.

Return Parameter

Error Code

Request Example for Creating BCC Instance

POST /v2/instance?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

{
    "instanceType": "N1",
    "cpuCount": 2,
    "memoryCapacityInGB": 2,
    "rootDiskSizeInGb":45,
    "rootDiskStorageType":"cloud_hp1",
    "createCdsList": [
        {
            "storageType": "std1",
            "cdsSizeInGB": 5
        }
    ],
    "name": "example",
    "imageId": "m-mRjO3cjs",
    localDiskSizeInGB,
    "networkCapacityInMbps": 1,
    "autoRenewTimeUnit": "month",
    "autoRenewTime": 1,
    "cdsAutoRenew": true,
    "internetChargeType": "BANDWIDTH_POSTPAID_BY_HOUR",
    "purchaseCount": 1,
    "billing":{
        "paymentTiming":"Prepaid",
        "reservation": {
            "reservationLength": 1
        }
    },
    "relationTag": true,
    “tags": [
        {
            "tagKey":"tag1",
            "tagValue":"var1"
        }
    ],
    "keypairId":"k-R0J0BEA9"
    "deployIdList":["dset-42N1llvY"]
}

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"

    ]

}

Request Example (Creation of GPU Instance)

POST /v2/instance?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

{
  "instanceType": "G1",
  "gpuCard": "P4",
  "cardCount": 2,
  "cpuCount": 24,
  "memoryCapacityInGB": 80,
  "createCdsList": [
   {
        "storageType": "std1",
        "cdsSizeInGB": 5
   }
  ],
  "name": "example",
  "imageId": "m-Rx1dCMFF",
  "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"
    ]
}

Request Example for Creating DCC Instance

POST /v2/instance?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

{
    "cpuCount": 1,
    "memoryCapacityInGB": 2,
    "ephemeralDisks": [
        {
            "storageType": "sata",
            "sizeInGB": 1024
        },
        {
            "storageType": "sata",
            "sizeInGB": 1024
        }
    ],
    "name": "example",
    "imageId": "m-mRjO3cjs",
    "networkCapacityInMbps": 0,
    "dedicatedHostId": "d-YufwpQAe",
    "purchaseCount": 1
}

Return Example

HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Tue, 06 Sep 2016 10:08:44 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS

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