创建专属实例
更新时间:2020-06-15
创建专属实例
描述
本接口用于在专属服务器上创建专属实例。在创建专属实例时,以下操作可能与您的业务相关:
- 专属实例不参与计费。
 - 本接口用于创建一个或多个专属实例。
 - 支持批量创建,且如果创建过程中有一个专属实例创建失败,所有实例将全部回滚,均创建失败,如果创建时包含CDS,CDS也会回滚。
 - 专属实例支持创建、添加本地磁盘。
 - 本地磁盘不支持挂载、卸载、删除。
 - DCC允许用户自定义专属实例的cpu和内存等参数,所创建的专属实例资源将会使用DCC的资源。
 - 专属实例只能通过ephemeralDisks创建临时盘并指定磁盘类型。
 - 专属实例支持用户自定义安全组和子网,两者需要同时指定在同一个VPC下。如果未指定安全组和子网,在创建专属实例时会自动加入系统默认的安全组和子网内。
 
请求结构
                Plain Text
                
            
            1        POST /v{version}/dedicatedHost/instance?clientToken={clientToken} HTTP/1.1
2        Host: dcc.bj.baidubce.com
3        Authorization: authorization string
4        {
5            "instanceType": instanceType,
6            "cpuCount": cpuCoreCount,
7            "memoryCapacityInGB": memoryCapacityInGB,
8            "ephemeralDisks": [
9                {
10                    "storageType": storageType,
11                    "sizeInGB": size
12                },
13                {
14                    "storageType": storageType,
15                    "sizeInGB": size
16                }
17            ],
18            "createCdsList": [
19                {
20                    "storageType": storageType,
21                    "cdsSizeInGB": cdsSizeInGB
22                }
23            ],
24            "name": "name",
25            "imageId": "imageId",
26            "localDiskSizeInGB": localDiskSizeInGB,
27            "networkCapacityInMbps": networkCapacityInMbps,
28            "dedicatedHostId": dedicatedHostId,
29            "purchaseCount": purchaseCount,
30            "billing":{
31                "paymentTiming": paymentTiming,
32                "reservation": {
33                    "reservationLength": reservationLength
34                }
35            },
36            "zoneName": zoneName,
37            "subnetId": subnetId,
38            "securityGroupId": securityGroupId
39        }
            请求头域
除公共头域外,无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 | 
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 | 
| clientToken | String | 是 | Query参数 | 幂等性Token,是一个长度不超过64位的ASCII字符串。 | 
| imageId | String | 是 | RequestBody参数 | 待创建虚拟机实例的镜像ID,可通过调用查询镜像列表接口选择获取所需镜像ID。 | 
| billing | Billing | 是 | RequestBody参数 | 订单、计费相关参数 | 
| instanceType | String | 否 | RequestBody参数 | 待创建虚拟机实例的类型,具体可选类型参见下述InstanceType,为空时使用默认虚机类型。 | 
| cpuCount | int | 是 | RequestBody参数 | 待创建虚拟机实例的CPU核数,可选配置请参考区域机型以及可选配置。 | 
| memoryCapacityInGB | int | 是 | RequestBody参数 | 待创建虚拟机实例的内存容量,单位GB,可选配置请参考区域机型以及可选配置。 | 
| rootDiskSizeInGb | int | 否 | RequestBody参数 | 待创建虚拟机实例的系统盘大小,单位GB,默认是40GB,范围为[40, 100]GB,超过40GB按照云磁盘价格收费。注意指定的系统盘大小需要满足所使用镜像最小磁盘空间限制。 | 
| rootDiskStorageType | String | 否 | RequestBody参数 | 待创建虚拟机实例系统盘介质,默认使用SSD型云磁盘,可指定系统盘磁盘类型可参见StorageType。 | 
| localDiskSizeInGB | int | 否 | RequestBody参数 | [已废弃]待创建虚拟机实例的临时数据盘大小(不含系统盘,系统盘为免费赠送),单位为GB,大小为0~500G,请采用ephemeralDisks字段。 | 
| ephemeralDisks | List<EphemeralDisk> | 否 | RequestBody参数 | DCC实例可以创建多块本地盘,需要指定磁盘类型以及大小。其他类型BCC最多只能使用一块本地盘,使用默认磁盘类型,需要指定磁盘大小。FPGA实例以及GPU实例默认使用一块本地磁盘,根据配置指定本地盘大小,具体请参考GPU型BCC可选规格配置 以及FPGA型BCC可选规格配置 。 | 
| createCdsList | List<CreateCdsModel> | 否 | RequestBody参数 | 待创建的CDS磁盘列表,具体数据格式参见下述CreateCdsModel | 
| networkCapacityInMbps | int | 否 | RequestBody参数 | 公网带宽,单位为Mbps。必须为0~200之间的整数,为0表示不分配公网IP,默认为0Mbps | 
| internetChargeType | String | 否 | RequestBody参数 | 公网带宽计费方式,可选参数详见internetChargeType,若不指定internetChargeType,默认付费方式同BCC,预付费默认为包年包月按带宽,后付费默认为按使用带宽计费。 | 
| dedicatedHostId | String | 是 | RequestBody参数 | 专属服务器id,指定虚机置放位置时指定该值。 | 
| purchaseCount | int | 否 | RequestBody参数 | 批量创建(购买)的虚拟机实例个数,必须为大于0的整数,可选参数,缺省为1 | 
| name | String | 否 | RequestBody参数 | 虚拟机名字(可选)。默认都不指定name。如果指定name:批量时name作为名字的前缀。后端将加上后缀,后缀生成方式:name{ -序号}。如果没有指定name,则自动生成,方式:{instance-八位随机串-序号}。注:随机串从0~9a~z生成;序号按照count的数量级,依次递增,如果count为100,则序号从000~100递增,如果为10,则从00~10递增。支持大小写字母、数字、中文以及-_ /.特殊字符,必须以字母开头,长度1-65。 | 
| adminPass | String | 否 | RequestBody参数 | 待指定的实例管理员密码,8-16位字符,英文,数字和符号必须同时存在,符号仅限!@#$%*(),密码需要加密传输,详见链接 | 
| zoneName | String | 否 | RequestBody参数 | zoneName命名规范是“国家-region-可用区序列",小写,例如北京可用区A为"cn-bj-a"。专属实例使用专属服务器所在zone,无需指定该字段。 | 
| subnetId | String | 否 | RequestBody参数 | 指定subnet信息,为空时将使用默认子网 | 
| securityGroupId | String | 否 | RequestBody参数 | 指定securityGroup信息,为空时将使用默认安全组 | 
| gpuCard | String | 否 | RequestBody参数 | 待创建实例所要携带的GPU卡信息,具体可选信息参照GpuType,非GPU型实例无需指定此字段 | 
| fpgaCard | String | 否 | RequestBody参数 | 待创建实例所要携带的FPGA卡信息,具体可选信息参照FpgaType,非FPGA型实例无需指定此字段 | 
| cardCount | String | 否 | RequestBody参数 | 待创建实例所要携带的GPU卡FPGA卡数量,仅在gpuCard或fpgaCard字段不为空时有效,且需要满足GPU型BCC可选规格配置 以及FPGA型BCC可选规格配置 | 
返回头域
除公共头域外,无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| instanceIds | List | 
虚机实例ID的集合,其中ID符合BCE规范,必须是一个定长字符串,且只允许包含大小写字母、数字、连字号(-)和下划线(_)。 | 
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 | 
|---|---|---|---|
| Instance.InsufficientRootDiskSize | Not enough root disk size. | 400 | 使用镜像过大,系统盘大小不够 | 
| Instance.InvalidateRootDiskStorageType | Invalidate root disk storage type. | 400 | 无效的系统盘介质 | 
| Instance.InstanceBeBanned | The instance is banned, contact technical support for assistance. | 403 | Bcc服务已被封禁 | 
| Instance.GlobalInstanceQuotaLimitExceeded | Quota exceeds limit for regional postpaid instances pool, contact technical support for further assistance. | 413 | 后付费类型的虚机数目超出当前区域预售额度限制 | 
| Instance.InstanceQuotaLimitExceeded | Quota exceeds limit. | 413 | 实例个数超过限制 | 
| Instance.EipQuotaLimitExceeded | The number of eip will exceed the limit. | 413 | 合并购买时eip个数超过限制 | 
| Instance.InvalidateConfiguration | Invalidate cpu memory configuration. | 400 | 无效的虚机配置 | 
请求示例
                Plain Text
                
            
            1        POST /v1/dedicatedHost/instance?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2        Host: dcc.bj.baidubce.com
3        ContentType: application/json
4        Authorization: bce-auth-v1/4e69d28643af46dea51fef90e221eb17/2019-02-12T09:21:27Z/1800/host;x-bce-date/a582637d5d092ac735a88756ddf3274425fb497f0bcc5cd0e425740d24838be0
5        {
6            "cpuCount": 1,
7            "memoryCapacityInGB": 1,
8            "ephemeralDisks": [
9                {
10                    "storageType": "ssd",
11                    "sizeInGB": 40
12                }
13            ],
14            "name" : "example",
15            "imageId": "m-0N8yoUGf",
16            "networkCapacityInMbps": 0,
17            "dedicatedHostId": "d-1xU2a1k1",
18            "purchaseCount": 1
19        }
            返回示例
                Plain Text
                
            
            1        HTTP/1.1 200 OK
2        x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3        Content-Type: application/json;charset=UTF-8
4        Server: BWS
5        {
6            "instanceIds": [
7                "i-aDrQKA9U"
8            ]
9        }
            