创建BEC虚机服务
更新时间：2025-08-05
接口描述
本接口用于创建BEC虚机服务以及相应的虚机实例。
请求结构
Plain Text
1 POST /v1/vm/service HTTP/1.1
2 Host: bec.baidubce.com
3 Authorization: authorization string
4 {
5 "serviceName": serviceName,
6 "vmName": vmName,
7 "paymentMethod": paymentMethod,
8 "reservation": {
9 "length": 1,
10 "timeUnit": "month"
11 },
12 "autoRenew": {
13 "length": 6,
14 "timeUnit": "month"
15 },
16 "needPublicIp": needPublicIp,
17 "bandwidth": bandwidth,
18 "deployInstances": [
19 {
20 "regionId": regionId,
21 "region": region,
22 "serviceProvider": serviceProvider,
23 "city": city,
24 "networkType":"vpc",
25 "vpcId": vpcId,
26 "subnetId": subnetId,
27 "replicas": replicas
28 },
29 {
30 "regionId": regionId,
31 "region": region,
32 "serviceProvider": serviceProvider,
33 "city": city,
34 "networkType":"vpc",
35 "replicas": replicas
36 }
37 ],
38 "needIpv6PublicIp": false,
39 "spec": spec,
40 "cpu": cpu,
41 "memory": memory,
42 "imageId": imageId,
43 "imageType": bec,
44 "systemVolume": {
45 "volumeType": SATA,
46 "name": vm-rootfs,
47 "sizeInGB": 40
48 },
49 "dnsConfig": {
50 "dnsType": dnsType,
51 "dnsAddress": dnsAddress
52 },
53 "keyConfig": {
54 "type": "password",
55 "adminPass": "adminPass",
56 },
57 "dataVolumeList": [
58 {
59 "name": name,
60 "volumeType": volumeType,
61 "sizeInGB": sizeInGB
62 },
63 {
64 "name": name,
65 "volumeType": volumeType,
66 "sizeInGB": sizeInGB
67 }
68 ],
69 "disableIntranet": disableIntranet,
70 "disableCloudInit": disableCloudInit,
71 "networkConfigList": [
72 {
73 "nodeType": "SINGLE",
74 "networksList": [
75 {
76 "netType": netType,
77 "netName": netName
78 },
79 {
80 "netType": netType,
81 "netName": netName
82 }
83 ]
84 }
85 ],
86 "securityGroupIds": [sgId, sgId],
87 "hostname": "hostname",
88 "templateId": templateId,
89 "deploysetIdList": ["deploysetId"],
90 "userData": "userData",
91 "cudaVersion": "cudaVersion",
92 "driverVersion": "driverVersion",
93 "cudnnVersion": "cudnnVersion",
94 "tags": [
95 {
96 "tagKey": "",
97 "tagValue": ""
98 }
99 ]
100 }请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| serviceName | String | 否 | RequestBody参数 | 虚机服务名称（不传则使用随机名称） |
| vmName | String | 否 | RequestBody参数 | 虚机实例名称（不传则使用随机名称） |
| paymentMethod | String | 否 | RequestBody参数 | 付费方式。postpay：后付费；prepay：预付费。缺省值为postpay |
| needPublicIp | Boolean | 否 | RequestBody参数 | 是否开通公网。true：开通；false：不开通。缺省为false |
| reservation | Reservation | 否 | RequestBody参数 | 预付费套餐购买时长 |
| autoRenew | AutoRenew | 否 | RequestBody参数 | 自动续费周期，系统将于资源到期前7/3/1/0天自动进行扣款续费，自动扣费时余额不足则顺延至下一次定时扣费，扣费时长与自动续费周期相等，不传则不自动续费 |
| bandwidth | Integer | 否 | RequestBody参数 | 公网带宽大小（-1时为最大值），单位Mbps |
| deployInstances | List<DeploymentInstance> | 是 | RequestBody参数 | 部署区域 |
| dnsConfig | DnsConfig | 是 | RequestBody参数 | DNS配置 |
| spec | String | 否 | RequestBody参数 | 规格族，传入按指定机型策略创建，不传则按随机分配策略创建；使用spec参数则不需要填写cpu/memory |
| 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 | VolumeConfig | 是 | 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，缺省为默认命名。网卡命名参考：网卡命名注意事项 |
| securityGroupIds | List<String> | 否 | RequestBody参数 | 指定私有网络的安全组ID。只适用于DeploymentInstance的网络类型（networkType）为vpc的实例。如果选用了vpc网络，但是没有指定安全组ID，BEC会创建并使用一个“出站方向端口全开”的默认的安全组。详情参考使用VPC网络注意事项 |
| hostname | String | 否 | RequestBody参数 | 设置本虚机组内的虚机的hostname（不传则使用随机名称）。批量创建时以hostname作为前缀加上序号后缀：name{-序号}，序号按照数量从0递增，例如name-0，name-1。hostname仅支持小写字母、数字以及-特殊字符，必须以字母开头，长度2-64。 |
| templateId | String | 否 | RequestBody参数 | 使用虚机模板ID创建虚机（需要先通过控制台创建虚机模板，ID格式为tmpl-xxxxx)， |
| deploysetIdList | List<String> | 否 | RequestBody参数 | 部署集ID列表，目前只支持数量为1。 |
| userData | String | 否 | RequestBody参数 | 自定义注入的数据，以如下的方式编码： base64(user_injected_data: base64(原文))。注意：user_injected_data冒号后+1个空格+base64字符串。 |
| cudaVersion | String | 否 | RequestBody参数 | CUDA 版本。linux或windows平台，三位版本号；只适用于创建异构计算GPU实例，开启自定义驱动安装时必填；注意：CUDA、Driver、cuDNN需要满足依赖关系 |
| driverVersion | String | 否 | RequestBody参数 | GPU驱动 版本。linux或windows平台；只适用于创建异构计算GPU实例，开启自定义驱动安装时必填；注意：CUDA、Driver、cuDNN需要满足依赖关系 |
| cudnnVersion | String | 否 | RequestBody参数 | cuDNN 版本。linux或windows平台，三位版本号；只适用于创建异构计算GPU实例，开启自定义驱动安装时必填 ；注意：CUDA、Driver、cuDNN需要满足依赖关系 |
| tags | List<TagModel> | 否 | RequestBody参数 | 标签信息 |
创建独占盘注意事项
独占盘仅支持数据盘，需要开通独占盘相关白名单才能创建，有相关需要请联系BEC商务。独占盘有SSD和HDD独占盘两种，volumeType和passthroughCode为必填参数，相关参数可通过获取独占盘接口获取。以下展示的是创建普通HDD数据盘、1T的SSD独占盘和4T的HDD独占盘。
Plain Text
1 POST /v1/vm/service HTTP/1.1
2 Host: bec.baidubce.com
3 Authorization: authorization string
4 {
5 "dataVolumeList": [
6 {
7 "volumeType": "SATA",
8 "accessModes": [],
9 "sizeInGB": 20,
10 "name": "data"
11 },
12 {
13 "volumeType": "SSD_PASSTHROUGH",
14 "name": "test1",
15 "passthroughCode": "SSD_PASSTHROUGH_1T"
16 },
17 {
18 "volumeType": "HDD_PASSTHROUGH",
19 "name": "test2",
20 "passthroughCode": "HDD_PASSTHROUGH_4T"
21 }
22 ],
23 "keyConfig": {
24 "type": "password",
25 "adminPass": "adminPass",
26 },
27 "imageId": "imageId",
28 "imageType": "bec",
29 "bandwidth": 100,
30 "systemVolume": {
31 "sizeInGB": 40,
32 "volumeType": "SATA",
33 "name": "system"
34 },
35 "deployInstances": [
36 {
37 "regionId": "cn-shanghai-ct",
38 "region": "EAST_CHINA",
39 "replicas": 1,
40 "city": "SHANGHAI",
41 "serviceProvider": "CHINA_TELECOM",
42 "hasGpu": false
43 }
44 ],
45 "serviceName": "test",
46 "vmName": "test",
47 "purchaseMonth": null,
48 "needPublicIp": false,
49 "needIpv6PublicIp": false,
50 "cpu": 1,
51 "memory": 2,
52 "paymentMethod": "postpay"
53 }密码和密钥配置注意事项
目前虚机登录支持密码和密钥两种方式，密码和密钥需要二选一。密码长度范围为8～32位字符，由英文、数字和符号组成，符号仅限!@#$%^+*()。密钥目前仅支持BCC密钥，要使用密钥开启必须先在BCC的华北-北京区域创建密钥对。以下是使用密钥对的虚机服务，keyConfig的type填bccKeyPair，bccKeyPairIdList是bcc密钥对的keyId，可以通过BCC查询密钥对列表获取keyId。
Plain Text
1 POST /v1/vm/service HTTP/1.1
2 Host: bec.baidubce.com
3 Authorization: authorization string
4 {
5 "disableIntranet": false,
6 "systemVolume": {
7 "volumeType": "SATA",
8 "name": "vm-rootfs",
9 "sizeInGB": 40
10 },
11 "keyConfig": {
12 "type": "bccKeyPair",
13 "bccKeyPairIdList": [
14 "k-yykLneJS"
15 ]
16 },
17 "needPublicIp": false,
18 "dataVolumeList": [],
19 "deployInstances": [
20 {
21 "regionId": "cn-taiyuan-cm",
22 "serviceProvider": "CHINA_MOBILE",
23 "region": "NORTH_CHINA",
24 "city": "TAIYUAN",
25 "replicas": 1
26 }
27 ],
28 "disableCloudInit": false,
29 "rootDiskSizeInGb": null,
30 "cpu": 1,
31 "purchaseMonth": null,
32 "bandwidth": 100,
33 "needIpv6PublicIp": false,
34 "memory": 2,
35 "serviceName": "test",
36 "imageId": "im-yykLneJS",
37 "imageType": "bec",
38 "paymentMethod": "postpay"
39 }网卡命名注意事项
参数结构networkConfigList用于设定网卡名称、VPC内外网卡的顺序。
-
仅内网，示例：
Plain Text1 "networkConfigList": [ 2 { 3 "nodeType": "SINGLE", 4 "networksList": [ 5 { 6 "netType": "INTERNAL_IP", 7 "netName": "netName" 8 } 9 ] 10 } 11 ] - 内网+外网，示例：
Plain Text
1 "networkConfigList": [
2 {
3 "nodeType": "SINGLE",
4 "networksList": [
5 {
6 "netType": "INTERNAL_IP",
7 "netName": "netName1"
8 },
9 {
10 "netType": "PUBLIC_IP",
11 "netName": "netName2"
12 }
13 ]
14 }
15 ]- 单线节点VPC网络多网卡，示例（内网+外网+内网+外网）：
单线节点的VPC网络，可以通过networkConfigList指定多网卡名和内外网的网卡顺序。
Plain Text
1 "networkConfigList": [
2 {
3 "nodeType": "SINGLE",
4 "networksList": [
5 {
6 "netType": "INTERNAL_IP",
7 "netName": "netName0"
8 },
9 {
10 "netType": "PUBLIC_IP",
11 "netName": "netName1"
12 },
13 {
14 "netType": "INTERNAL_IP",
15 "netName": "netName2"
16 },
17 {
18 "netType": "PUBLIC_IP",
19 "netName": "netName3"
20 }
21 ]
22 }
23 ]- 三线节点VPC网络，公网IP指定运营商：
可以通过下面二选一参数来指定： 通过参数subServiceProviders直接指定，或者通过networkConfigList指定运营商并设置网卡名和网卡顺序。例如只支持运营商ct的示例：
Plain Text
1 // 通过subServiceProviders指定运营商
2 "deployInstances": [
3 {
4 "regionId": "cn-changchun-ix",
5 "replicas": 1,
6 "subServiceProviders": ["ct"],
7 "networkType":"vpc"
8 }
9 ],
10 // 通过networkConfigList指定运营商并设置网卡名和顺序
11 "networkConfigList": [
12 {
13 "nodeType": "TRIPLE",
14 "networksList": [
15 {
16 "netType": "INTERNAL_IP",
17 "netName": "netName"
18 },
19 {
20 "netType": "TRIPLE_CT",
21 "netName": "netName"
22 }
23 ]
24 }
25 ]使用VPC网络注意事项
VPC网络为内网VPC，分节点创建，不能跨节点指定VPC。需要显式指定网络类型networkType为vpc，经典网络为classic
vpc网络可以指定使用自定义已创建好的vpcId和subnetId； 如果没有指定vpcId和subnetId，系统会为每个节点创建并使用默认的私有网络和子网；默认私有网络CIDR为172.16.0.0/20，默认子网CIDR为172.16.0.0/24
Plain Text
1 "deployInstances": [
2 {
3 "regionId": regionId,
4 "networkType":"vpc",
5 "vpcId": vpcId,
6 "subnetId": subnetId,
7 "replicas": replicas
8 }
9 ]指定安全组（securityGroupIds）只适用于vpc网络的实例。如果选用了vpc网络但是没有指定安全组ID，BEC会创建并使用一个默认的安全组，默认安全组规则如下：
| 方向 | 协议 | 端口 | 类型 | 目的地址 |
|---|---|---|---|---|
| 出站 | 全部协议 | 1-65535 | IPv4 | 目的IP: 0.0.0.0/0 |
使用模板
若使用模板，需要先在控制台创建虚机模板，获得templateId作为输入参数。无需再传入cpu、memory、disk、imageId/imageType、dnsConfig等参数。例如：
Plain Text
1 POST /v1/vm/service HTTP/1.1
2 Host: bec.baidubce.com
3 Authorization: authorization string
4 {
5 "deployInstances": [
6 {
7 "regionId": "cn-changchun-ix",
8 "replicas": 1,
9 "networkType": "vpc"
10 }
11 ],
12 "serviceName": "service-test",
13 "vmName": "vmtest",
14 "templateId": "tmpl-2rnoykpn"
15 }响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | Boolean | 返回结果，true表示成功；false：表示失败 |
| action | String | 操作描述 |
| details | VmServiceBriefVo | 返回结果 |
错误码
请参照错误返回章节的内容。
请求示例
DeploymentInstance支持regionId
Plain Text
1 POST /v1/vm/service HTTP/1.1
2 Host: bec.baidubce.com
3 Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5 {
6 "dataVolumeList": [
7 {
8 "volumeType": "SATA",
9 "sizeInGB": 20,
10 "name": "data-disk-name"
11 }
12 ],
13 "keyConfig": {
14 "type": "password",
15 "adminPass": "password1234!"
16 },
17 "imageId": "im-DqQdV8VQ",
18 "imageType": "bec",
19 "bandwidth": 100,
20 "deployInstances": [
21 {
22 "regionId": "cn-chengdu-un",
23 "networkType": "vpc",
24 "vpcId": "vpc-a1243lj",
25 "subnetId": "sbn-ou15jlg",
26 "replicas": 1
27 }
28 ],
29 "systemVolume": {
30 "volumeType": "SATA",
31 "name": "system-disk-name",
32 "sizeInGB": 40
33 },
34 "dnsConfig": {
35 "dnsType": "CUSTOMIZE",
36 "dnsAddress": "129.29.29.29"
37 },
38 "serviceName": "test",
39 "vmName": "vmName",
40 "purchaseMonth": null,
41 "needPublicIp": false,
42 "spec": "bec.c2.c4m8",
43 "cpu": 4,
44 "memory": 8,
45 "paymentMethod": "postpay",
46 "disableIntranet": false,
47 "disableCloudInit": false,
48 "networkConfigList": [
49 {
50 "nodeType": "SINGLE",
51 "networksList": [
52 {
53 "netType": "INTERNAL_IP",
54 "netName": "intra"
55 },
56 {
57 "netType": "PUBLIC_IP",
58 "netName": "extra"
59 }
60 ]
61 }
62 ],
63 "securityGroupIds": ["sg-1okhf15"],
64 "deploysetIdList": ["dset-enckow4i"],
65 "tags": [
66 {
67 "tagKey": "tagKey",
68 "tagValue": "tagValue"
69 }
70 ]
71 }DeploymentInstance兼容region/city/serviceProvider
Plain Text
1 POST /v1/vm/service HTTP/1.1
2 Host: bec.baidubce.com
3 Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5 {
6 "dataVolumeList": [
7 {
8 "volumeType": "SATA",
9 "sizeInGB": 20,
10 "name": "data-disk-name"
11 }
12 ],
13 "keyConfig": {
14 "type": "password",
15 "adminPass": "password1234!"
16 },
17 "imageId": "im-DqQdV8VQ",
18 "imageType": "bec",
19 "bandwidth": 100,
20 "deployInstances": [
21 {
22 "region": "SOUTH_WEST",
23 "city": "CHENGDU",
24 "serviceProvider": "CHINA_UNICOM",
25 "networkType": "vpc",
26 "vpcId": "vpc-a1243lj",
27 "subnetId": "sbn-ou15jlg",
28 "replicas": 1
29 }
30 ],
31 "systemVolume": {
32 "volumeType": "SATA",
33 "name": "system-disk-name",
34 "sizeInGB": 40
35 },
36 "dnsConfig": {
37 "dnsType": "CUSTOMIZE",
38 "dnsAddress": "129.29.29.29"
39 },
40 "serviceName": "test",
41 "vmName": "vmName",
42 "purchaseMonth": null,
43 "needPublicIp": false,
44 "spec": "bec.c2.c4m8",
45 "cpu": 4,
46 "memory": 8,
47 "paymentMethod": "postpay",
48 "disableIntranet": false,
49 "disableCloudInit": false,
50 "networkConfigList": [
51 {
52 "nodeType": "SINGLE",
53 "networksList": [
54 {
55 "netType": "INTERNAL_IP",
56 "netName": "intra"
57 },
58 {
59 "netType": "PUBLIC_IP",
60 "netName": "extra"
61 }
62 ]
63 }
64 ],
65 "securityGroupIds": ["sg-1okhf15"],
66 "deploysetIdList": ["dset-enckow4i"],
67 "tags": [
68 {
69 "tagKey": "tagKey",
70 "tagValue": "tagValue"
71 }
72 ]
73 }响应示例
Plain Text
1 HTTP/1.1 200 OK
2 Content-Type: application/json;charset=UTF-8
3 Date: Wed, 08 Jul 2015 03:28:11 GMT
4 x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5 Server: BWS
6
7 {
8 "result": true,
9 "action": "create",
10 "details": {
11 "serviceId": "s-zz9r0enj",
12 "serviceName": "test",
13 "status": "NORMAL",
14 "totalCpu": 1,
15 "totalMem": 2,
16 "totalDisk": 0,
17 "totalRootDisk": 40,
18 "regions": 1,
19 "deployInstances": [
20 {
21 "regionId": "cn-taiyuan-cm",
22 "region": "NORTH_CHINA",
23 "serviceProvider": "CHINA_MOBILE",
24 "replicas": 1,
25 "city": "TAIYUAN"
26 }
27 ],
28 "totalInstances": 1,
29 "runningInstances": 0,
30 "osImage": {
31 "id": "5732f5cf-fd17-4e6b-a044-e95bed7da02e",
32 "imageId": "im-DqQdV8VQ",
33 "name": "qa-hello-world",
34 "imageType": "becCommon",
35 "snapshotId": "",
36 "cpu": 1,
37 "memory": 2,
38 "osType": "linux",
39 "osVersion": "7.5",
40 "osName": "CentOS",
41 "osBuild": "2019110600",
42 "osLang": "ENG",
43 "diskSize": 0,
44 "createTime": "2020-10-22T03:59:36Z",
45 "status": "active",
46 "minMem": 1,
47 "minCpu": 0,
48 "minDiskGb": 40,
49 "desc": "centos-7u5-x86_64-20191105105756",
50 "osArch": "x86_64 (64bit)",
51 "ephemeralSize": 0,
52 "imageDescription": "centos-7u5-x86_64-20191105105756",
53 "shareToUserNumLimit": 0,
54 "sharedToUserNum": 0,
55 "fpgaType": "",
56 "name_fri": null
57 },
58 "createTime": null,
59 "totalGpu": 0,
60 "bandwidth": null,
61 "totalBandwidth": "0Mbps"
62 }
63 }Model对象定义
VmServiceBriefVo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| serviceId | String | 虚机服务ID |
| serviceName | String | 虚机服务名称 |
| status | String | 资源状态（NORMAL，FAILED） |
| totalCpu | float | CPU数量 |
| totalMem | float | 内存数量 |
| totalRootDisk | Integer | 系统盘数量 |
| totalDisk | Integer | 数据盘数量 |
| regions | Integer | 区域数量 |
| deployInstances | List<DeploymentInstance> | 部署区域列表 |
| 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_SSD或CDS_HDD， 独占盘类型包括HDD_PASSTHROUGH和SSD_PASSTHROUGH |
| passthroughCode | String | 独占盘套餐码，非独占盘不需要填写,独占盘套餐码可通过获取独占盘接口获取 |
DeploymentInstance
| 参数名称 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| regionId | String | 是 | 节点ID，由“国家码-城市-运营商”的小写字母组成字符串。例如 cn-hangzhou-cm，其中国家码标准为ISO 3166-2，城市为拼音，运营商为中国移动cm/中国电信ct/中国联通un/三线ix/bgp。如果传regionId，则可以不传region、serviceProvider、city。 |
| region | Region | 否 | 区域 |
| city | String | 否 | 城市 |
| serviceProvider | ServiceProvider | 否 | 运营商 |
| subServiceProviders | List<String> | 否 | 仅适用于VPC三线节点。可以指定运营商公网，值为ct，un，cm的数组，其中ct电信、un联通、cm移动。如果不指定该参数则默认三个运营商 |
| replicas | Integer | 是 | 副本数，最小为1 |
| networkType | String | 是 | 指定网络类型，枚举值有classic（经典网络）或vpc（VPC网络）。详细参考 使用VPC网络注意事项 |
| vpcId | String | 否 | 指定私有网络ID。只有网络类型为vpc时生效；如果networkType选用vpc网络, 若不指定vpcId时则使用默认私有网络和默认子网 |
| subnetId | String | 否 | 指定私有网络的子网ID。只有网络类型为vpc时生效；如果networkType选用vpc网络, 若不指定subnetId时则会使用默认VPC的默认子网 |
DnsConfig
| 参数名称 | 类型 | 描述 |
|---|---|---|
| dnsType | DnsType | DNS类型 |
| dnsAddress | String | DNS地址，多个DNS地址以逗号分隔 |
DnsType
| 类型 | 描述 |
|---|---|
| NONE | 不需要设置 |
| DEFAULT | 国内节点使用默认DNS地址(114.114.114.114), 海外节点使用默认DNS地址(8.8.8.8) |
| CUSTOMIZE | 使用自定义DNS地址 |
NetworkConfig
| 参数名称 | 类型 | 描述 |
|---|---|---|
| nodeType | String | 节点类型(SINGLE、TRIPLE，分别表示单线节点和三线节点) |
| networksList | List<Networks> | 网卡信息，包含Networks；用于设置对应的网卡名称。注意： 经典网络顺序固定为内+外，不可自定义；VPC网络可以自定义网卡顺序 |
Networks
| 参数名称 | 类型 | 描述 |
|---|---|---|
| netType | String | 网卡类型 (INTERNAL_IP表示内网；单线节点使用PUBLIC_IP表示单线公网网卡；三线节点用TRIPLE_CT、TRIPLE_UN、TRIPLE_CM分别表示三线公网的电信、联通、移动) |
| netName | String | 网卡名称，内外网卡的名称不能重复；支持大小写字母，数字，"-_"，必须以字母开头，长度3-16字符。 |
KeyConfig
| 参数名称 | 类型 | 描述 |
|---|---|---|
| type | String | 类型，bccKeyPair为选择的密钥对，password为选择的密码 |
| bccKeyPairIdList | List<String> | 虚机密钥对ID列表 |
| adminPass | String | 虚机密码限制长度为8～32位字符，英文、数字和符号必须同时存在，符号仅限!@#$%^+*() |
ServiceProvider
| 编码 | 描述 |
|---|---|
| CHINA_MOBILE | 中国移动 |
| CHINA_UNICOM | 中国联通 |
| CHINA_TELECOM | 中国电信 |
| TRIPLE_LINE | 三线 |
| BGP | BGP |
Reservation
| 参数名称 | 类型 | 描述 |
|---|---|---|
| length | Integer | 预付费套餐购买时长 |
| timeUnit | String | 时间单位 year 或者 month |
AutoRenew
| 参数名称 | 类型 | 描述 |
|---|---|---|
| length | Integer | 预付费自动续费的续费时长 |
| timeUnit | String | 时间单位 year 或者 month |
TagModel
| 参数名称 | 类型 | 描述 |
|---|---|---|
| tagKey | String | 标签键 |
| tagValue | String | 标签值 |