创建BEC虚机服务

更新时间：2021-08-03

接口描述

本接口用于创建BEC虚机服务以及相应的虚机实例。

请求结构

POST /v1/vm/service HTTP/1.1
Host: bec.baidubce.com
Authorization: authorization string
{
    "serviceName": serviceName,
    "vmName": vmName,
    "paymentMethod": paymentMethod,
    "needPublicIp": needPublicIp,
    "bandwidth": bandwidth,
    "deployInstances": [
        {
            "region": region,
            "serviceProvider": serviceProvider,
            "city": city,
            "replicas": replicas
        },
        {
            "region": region,
            "serviceProvider": serviceProvider,
            "city": city,
            "replicas": replicas
        }
    ],
    "needIpv6PublicIp": false,
    "cpu": cpu,
    "memory": memory,
    "imageId": imageId,
    "imageType": bec,
    "systemVolume": {
        "volumeType": SATA,
        "name": vm-rootfs,
        "sizeInGB": 40
    },
    "dnsConfig": {
        "dnsType": dnsType,
        "dnsAddress": dnsAddress
    },
    "keyConfig": {
        "type": "password",
        "adminPass": "adminPass",
    },
    "dataVolumeList": [
        {
            "name": name,
            "volumeType": volumeType,
            "sizeInGB": sizeInGB
        }, 
        {
            "name": name,
            "volumeType": volumeType,
            "sizeInGB": sizeInGB
        }
     ],
    "disableIntranet": disableIntranet,
    "disableCloudInit": disableCloudInit,
    "networkConfigList": [
        {
            "nodeType": "SINGLE",
            "networksList": [
                {
                    "netType": "netType",
                    "netName": "netName"
                },
                {
                    "netType": "netType",
                    "netName": "netName"
                }
            ]
        }
    ]
}

创建独占盘注意事项

独占盘仅支持数据盘，需要开通独占盘相关白名单才能创建，有相关需要请联系BEC商务。独占盘有SSD和HDD独占盘两种，volumeType和passthroughCode为必填参数，相关参数可通过获取独占盘接口获取。以下展示的是创建普通HDD数据盘、1T的SSD独占盘和4T的HDD独占盘。

POST /v1/vm/service HTTP/1.1
Host: bec.baidubce.com
Authorization: authorization string
{
    "dataVolumeList": [
        {
            "volumeType": "SATA",
            "accessModes": [],
            "sizeInGB": 20,
            "name": "data"
        },
        {
            "volumeType": "SSD_PASSTHROUGH",
            "name": "test1",
            "passthroughCode": "SSD_PASSTHROUGH_1T"
        },
        {
            "volumeType": "HDD_PASSTHROUGH",
            "name": "test2",
            "passthroughCode": "HDD_PASSTHROUGH_4T"
        }
    ],
    "keyConfig": {
        "type": "password",
        "adminPass": "adminPass",
    },
    "imageId": "imageId",
    "imageType": "bec",
    "bandwidth": 100,
    "systemVolume": {
        "sizeInGB": 40,
        "volumeType": "SATA",
        "name": "system"
    },
    "deployInstances": [
        {
            "region": "EAST_CHINA",
            "replicas": 1,
            "city": "SHANGHAI",
            "serviceProvider": "CHINA_TELECOM",
            "hasGpu": false
        }
    ],
    "serviceName": "test",
    "vmName": "test",
    "purchaseMonth": null,
    "needIntranet": true,
    "needPublicIp": false,
    "needIpv6PublicIp": false,
    "cpu": 1,
    "memory": 2,
    "paymentMethod": "postpay"
}

密码和密钥配置注意事项

目前虚机登录支持密码和密钥两种方式，密码和密钥需要二选一。密码长度范围为8～32位字符，由英文、数字和符号组成，符号仅限!@#$%^+*()。密钥目前仅支持BCC密钥，要使用密钥开启必须先在BCC的华北-北京区域创建密钥对。以下是使用密钥对的虚机服务，keyConfig的type填bccKeyPair，bccKeyPairIdList是bcc密钥对的keyId，可以通过BCC查询密钥对列表获取keyId。

POST /v1/vm/service HTTP/1.1
Host: bec.baidubce.com
Authorization: authorization string
{
    "disableIntranet": false,
    "systemVolume": {
        "volumeType": "SATA",
        "name": "vm-rootfs",
        "sizeInGB": 40
    },
    "keyConfig": {
        "type": "bccKeyPair",
        "bccKeyPairIdList": [
            "k-yykLneJS"
        ]
    },
    "needPublicIp": false,
    "dataVolumeList": [],
    "deployInstances": [
        {
            "serviceProvider": "CHINA_MOBILE",
            "region": "NORTH_CHINA",
            "city": "TAIYUAN",
            "replicas": 1
        }
    ],
    "disableCloudInit": false,
    "rootDiskSizeInGb": null,
    "cpu": 1,
    "purchaseMonth": null,
    "bandwidth": 100,
    "needIpv6PublicIp": false,
    "memory": 2,
    "serviceName": "test",
    "imageId": "im-yykLneJS",
    "imageType": "bec",
    "paymentMethod": "postpay",
    "instanceType": null
}

网卡命名注意事项

仅单线节点支持网卡改名：

内网：

 "networkConfigList": [
        {
            "nodeType": "SINGLE",
            "networksList": [
                {
                    "netType": "INTERNAL_IP",
                    "netName": "netName"
                }
            ]
        }
    ]

内网+外网：

  "networkConfigList": [
         {
             "nodeType": "SINGLE",
             "networksList": [
                 {
                     "netType": "INTERNAL_IP",
                     "netName": "netName"
                 },
                 {
                     "netType": "PUBLIC_IP",
                     "netName": "netName"
                 }
             ]
         }
     ]

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
serviceName	String	否	RequestBody参数	虚机服务名称（不传则使用随机名称）
vmName	String	否	RequestBody参数	虚机实例名称（不传则使用随机名称）
paymentMethod	String	否	RequestBody参数	付费方式，目前只支持postpay。缺省值为postpay
needPublicIp	Boolean	否	RequestBody参数	是否开通公网。true：开通；false：不开通。缺省为false
bandwidth	Integer	否	RequestBody参数	公网带宽大小（-1时为最大值）
deployInstances	List<DeploymentInstance>	是	RequestBody参数	部署区域
dnsConfig	DnsConfig	是	RequestBody参数	DNS配置
cpu	Integer	是	RequestBody参数	CPU大小，必须大于1
memory	Integer	是	RequestBody参数	memory大小，必须大于1
imageId	String	是	RequestBody参数	镜像ID（配合imageType使用）
imageType	String	是	RequestBody参数	镜像类型（bec为公共镜像或bec自定义镜像，镜像ID可从获取BEC虚机镜像列表获取，bcc为bcc自定义镜像），缺省为bcc
needIpv6PublicIp	boolean	是	RequestBody参数	是否开通IPv6公网。true：开通；false：不开通。缺省为false
systemVolume	VolumnConfig	是	RequestBody参数	系统盘配置
dataVolumeList	List<VolumeConfig>	否	RequestBody参数	数据盘配置
keyConfig	KeyConfig	是	RequestBody参数	密码或密钥配置
disableIntranet	Boolean	否	RequestBody参数	是否需要内网。true：需要；false：不需要。缺省为false
disableCloudInit	Boolean	否	RequestBody参数	是否需要网络初始化。true：需要；false：不需要。缺省为false
networkConfigList	List<NetworkConfig>	否	RequestBody参数	网卡命名配置列表，包含NetworkConfig，缺省为默认命名。仅支持单线节点，三线节点不传此参数

响应头域

除公共头域外，无其它特殊头域。

响应参数

参数名称	类型	描述
result	Boolean	返回结果，true：表示成功；false：表示失败。
action	String	操作描述
details	Map	返回结果，仅包含serviceId，类型为String

错误码

请参照错误返回章节的内容。

请求示例

POST /v1/vm/service HTTP/1.1
Host: bec.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
    "dataVolumeList": [
        {
            "volumeType": "SATA",
            "sizeInGB": 20,
            "name": "data-disk-name"
        }
    ],
    "keyConfig": {
        "type": "password",
        "adminPass": "password1234!",
    },
    "imageId": "im-DqQdV8VQ",
    "imageType": "bec",
    "bandwidth": 100,
    "deployInstances": [
        {
            "region": "SOUTH_WEST",
            "city": "CHENGDU",
            "serviceProvider": "CHINA_UNICOM",
            "replicas": 1
        }
    ],
    "systemVolume": {
        "volumeType": "SATA",
        "name": "system-disk-name",
        "sizeInGB": 40
    },
    "dnsConfig": {
        "dnsType": "CUSTOMIZE",
        "dnsAddress": "129.29.29.29"
    },
    "serviceName": "test",
    "vmName": "vmName",
    "purchaseMonth": null,
    "needPublicIp": false,
    "cpu": 4,
    "memory": 8,
    "paymentMethod": "postpay",
    "disableIntranet": false,
    "disableCloudInit": false,
    "networkConfigList": [
        {
            "nodeType": "SINGLE",
            "networksList": [
                {
                    "netType": "INTERNAL_IP",
                    "netName": "intra"
                },
                {
                    "netType": "PUBLIC_IP",
                    "netName": "extra"
                }
            ]
        }
    ]
}

响应示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2015 03:28:11 GMT
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
Server: BWS

{
    "result": true,
    "action": "create",
    "details": {
        "serviceId": "s-zz9r0enj",
        "serviceName": "test",
        "status": "NORMAL",
        "totalCpu": 1,
        "totalMem": 2,
        "totalDisk": 0,
        "totalRootDisk": 40,
        "regions": 1,
        "deployInstances": [
            {
                "region": "NORTH_CHINA",
                "serviceProvider": "CHINA_MOBILE",
                "replicas": 1,
                "city": "TAIYUAN"
            }
        ],
        "totalInstances": 1,
        "runningInstances": 0,
        "osImage": {
            "id": "5732f5cf-fd17-4e6b-a044-e95bed7da02e",
            "imageId": "im-DqQdV8VQ",
            "name": "qa-hello-world",
            "imageType": "becCommon",
            "snapshotId": "",
            "cpu": 1,
            "memory": 2,
            "osType": "linux",
            "osVersion": "7.5",
            "osName": "CentOS",
            "osBuild": "2019110600",
            "osLang": "ENG",
            "diskSize": 0,
            "createTime": "2020-10-22T03:59:36Z",
            "status": "active",
            "minMem": 1,
            "minCpu": 0,
            "minDiskGb": 40,
            "desc": "centos-7u5-x86_64-20191105105756",
            "osArch": "x86_64 (64bit)",
            "ephemeralSize": 0,
            "imageDescription": "centos-7u5-x86_64-20191105105756",
            "shareToUserNumLimit": 0,
            "sharedToUserNum": 0,
            "fpgaType": "",
            "name_fri": null
        },
        "createTime": null,
        "totalGpu": 0,
        "bandwidth": null,
        "totalBandwidth": "0Mbps"
    }
}

Model对象定义

ActionInfoVo

参数名称	类型	描述
result	Boolean	返回结果，true表示成功；false：表示失败
action	String	操作描述
details	Map	返回结果，包含VmServiceBriefVo

VmServiceBriefVo

参数名称	类型	描述
serviceId	String	虚机服务ID
serviceName	String	虚机服务名称
status	String	资源状态（NORMAL，FAILED）
totalCpu	float	CPU数量
totalMem	float	内存数量
totalRootDisk	Integer	系统盘数量
totalDisk	Integer	数据盘数量
regions	Integer	区域数量
deployInstances	List<DeploymentInstanc>	部署区域列表
totalInstances	Integer	总实例数
runningInstances	Integer	运行实例数
osImage	ImageDetail	系统镜像详情
createTime	Date	创建时间

ImageDetail

参数名称	类型	描述
id	String	ID
imageId	String	imageId
name	String	镜像名称
imageType	String	镜像类型
snapshotId	String	快照ID
cpu	Integer	CPU数量
memory	Integer	内存数量
osType	String	OS类型
osVersion	String	OS版本
osName	String	OS名称
osBuild	String	OS创建时间
osLang	String	OS语言
diskSize	Integer	磁盘大小
createTime	Date	创建时间
minCpu	Integer	最小CPU数量
minMem	Integer	最小内存数量
minDiskGb	Integer	最小磁盘数量
desc	String	描述
osArch	String	osArch
ephemeralSize	Integer	ephemeralSize
imageDescription	String	镜像描述
shareToUserNumLimit	Integer	分享数量限制
sharedToUserNum	Integer	分享数量
fpgaType	String	fpgaType
name_fri	String	name_fri

VolumeConfig

参数名称	类型	描述
name	String	磁盘名称
sizeInGB	Integer	磁盘大小(单位G)
volumeType	DiskType	磁盘类型，普通数据盘类型包括：NVME和SATA云磁盘类型包括：CDS_HDD，独占盘类型包括HDD_PASSTHROUGH和SSD_PASSTHROUGH
passthroughCode	String	独占盘套餐码，非独占盘不需要填写,独占盘套餐码可通过获取独占盘接口获取

DeploymentInstance

参数名称	类型	描述
region	Region	区域
serviceProvider	ServiceProvider	运营商
city	String	城市
replicas	Integer	副本数，最小为1

DnsConfig

参数名称	类型	描述
dnsType	DnsType	DNS类型
dnsAddress	String	DNS地址，多个DNS地址以逗号分隔

DnsType

类型	描述
NONE	不需要设置
DEFAULT	使用默认DNS地址(114.114.114.114)
CUSTOMIZE	使用自定义DNS地址

NetworkConfig

参数名称	类型	描述
nodeType	NodeType	节点类型(SINGLE)
networksList	List<Networks>	网卡信息，包含Networks

Networks

参数名称	类型	描述
netType	NetType	网卡类型(INTERNAL_IP、PUBLIC_IP)
netName	String	网卡名称，内外网卡的名称不能重复；支持大小写字母，数字，"-_"，必须以字母开头，长度3-16字符。

NetType

类型	描述
INTERNAL_IP	内网
PUBLIC_IP	外网

NodeType

类型	描述
SINGLE	单线

KeyConfig

参数名称	类型	描述
type	String	类型，bccKeyPair为选择的密钥对，password为选择的密码
bccKeyPairIdList	List<String>	虚机密钥对ID列表
adminPass	String	虚机密码限制长度为8～32位字符，英文、数字和符号必须同时存在，符号仅限!@#$%^+*()

ServiceProvider

编码	描述
CHINA_MOBILE	中国移动
CHINA_UNICOM	中国联通
CHINA_TELECOM	中国电信
TRIPLE_LINE	三线
INTRA	内网

获取BEC虚机服务列表

更新BEC虚机服务

边缘计算节点 BEC