创建BEC虚机服务
所有文档

          边缘计算节点 BEC

          创建BEC虚机服务

          创建BEC虚机服务

          接口描述

          创建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": bcc,
              "systemVolume": {
                  "volumeType": SATA,
                  "name": vm-rootfs,
                  "sizeInGB": 40
              },
              "dnsConfig": {
                  "dnsType": dnsType,
                  "dnsAddress": dnsAddress
              },
              "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"
                          }
                      ]
                  }
              ]
          }

          网卡命名注意事项:

          • 仅单线节点支持网卡改名:

            • 内网:
             "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
          needPublicIp boolean RequestBody参数 是否开通公网,缺省为false
          bandwidth int RequestBody参数 公网带宽大小(-1时为最大值)
          deployInstances List RequestBody参数 部署区域
          dnsConfig DnsConfig RequestBody参数 dns配置
          cpu int RequestBody参数 cpu大小,必须大于1
          memory int RequestBody参数 memory大小,必须大于1
          imageId String RequestBody参数 镜像id
          imageType String RequestBody参数 镜像类型(默认为bcc、仅使用bec虚机自定义镜像时为bec)
          needIpv6PublicIp boolean RequestBody参数 是否开通ipv6公网,缺省为false
          systemVolume VolumnConfig RequestBody参数 系统盘配置
          dataVolumeList List RequestBody参数 数据盘配置
          adminPass String RequestBody参数 密码,限制长度为8~32位字符,英文、数字和符号必须同时存在,符号仅限!@#$%^+*()
          disableIntranet boolean RequestBody参数 是否需要内网,缺省为false
          disableCloudInit boolean RequestBody参数 是否需要网络初始化,缺省为false
          networkConfigList List RequestBody参数 网卡命名配置列表,包含NetworkConfig,缺省为默认命名,仅支持单线节点,三线节点不传此参数

          响应头域

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

          响应参数

          参数名称 类型 描述
          result boolean 返回结果,true为成功
          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"
                  }
              ],
              "adminPass": "Password12345!",
              "imageId": "m-awDKZUma",
              "imageType": "bcc",
              "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": "STARTING",
                  "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": "m-yykLneJS",
                      "name": "qa-hello-world",
                      "imageType": "sharing",
                      "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为成功
          action String 操作描述
          details Map 返回结果,包含VmServiceBriefVo

          VmServiceBriefVo

          参数名称 类型 描述
          serviceId String 虚机服务ID
          serviceName String 虚机服务名称
          status String 资源状态(STOP,RUNNING,PENDING,TERMINATING,FAILED,SUCCEEDED,UNKNOWN,TERMINATED,WAITING)
          totalCpu float cpu数量
          totalMem float 内存数量
          totalRootDisk int 系统盘数量
          totalDisk int 数据盘数量
          regions int 区域数量
          deployInstances List 部署区域列表
          totalInstances int 总实例数
          runningInstances int 运行实例数
          osImage ImageDetail 系统镜像详情
          createTime Date 创建时间

          ImageDetail

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

          VolumeConfig

          参数名称 类型 描述
          name String 磁盘名称
          sizeInGB int 磁盘大小(单位G)
          volumeType DiskType 磁盘类型(NVME,SATA,HDD_PASSTHROUGH_4T,CDS_HDD)

          DeploymentInstance

          参数名称 类型 描述
          region Region 区域
          serviceProvider ServiceProvider 运营商
          city String 城市
          replicas int 副本数,最小为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

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

          NetType

          类型 描述
          INTERNAL_IP 内网
          PUBLIC_IP 外网

          NodeType

          类型 描述
          SINGLE 单线
          上一篇
          获取BEC虚机服务列表
          下一篇
          更新BEC虚机服务