重装BEC虚机实例系统
更新时间:2024-11-19
接口描述
本接口用于重装BEC虚机实例系统。
请求结构
Plain Text
1PUT /v1/vm/instance/{vmID}/system/reinstall HTTP/1.1
2Host: bec.baidubce.com
3Authorization: authorization string
4
5{
6 "keyConfig": {
7 "adminPass": "adminPass",
8 "type": "password"
9 },
10 "imageId": imageId,
11 "imageType": bec,
12 "resetDataDisk": false,
13 "userData": "userData",
14 "cudaVersion": "cudaVersion",
15 "driverVersion": "driverVersion",
16 "cudnnVersion": "cudnnVersion"
17}
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
vmID | String | 是 | URL参数 | 虚机实例ID |
keyConfig | KeyConfig | 是 | RequestBody参数 | 密码或密钥配置 |
imageId | String | 是 | RequestBody参数 | 镜像ID(配合imageType使用) |
imageType | String | 是 | RequestBody参数 | 镜像类型,取值为bec、bcc,分别表示为公共镜像或bec自定义镜像、bcc自定义镜像,缺省为bcc |
resetDataDisk | Boolean | 否 | RequestBody参数 | 重装是否需要重置数据盘。true:重置,false:不重置,默认不重置 |
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需要满足依赖关系 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
参数名称 | 类型 | 描述 |
---|---|---|
result | boolean | 操作是否成功,true:操作成功;false:操作失败 |
action | String | 更新操作,返回值为“update” |
details | VmInstanceDetailsVo | 虚机实例信息 |
错误码
请参照错误返回章节的内容。
请求示例
Plain Text
1PUT /v1/vm/instance/vm-6ahy6dli/system/reinstall HTTP/1.1
2Host: bec.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6 "keyConfig": {
7 "adminPass": "root@!123456",
8 "type": "password"
9 },
10 "imageId":"im-awwxnhme-2-u-huhehaote",
11 "imageType":"bec"
12}
响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7{
8 "result": true,
9 "action": "reinstall",
10 "details": {
11 "publicIp": "36.158.184.31",
12 "ipv6PublicIp": "",
13 "internalIp": null,
14 "multiplePublicIp": null,
15 "serviceProvider": "CHINA_MOBILE",
16 "vmId": "vm-i029wtci-0-m-xiangtan-f1gvv",
17 "uuid": "76050e65-b8e5-4fcf-a61b-dd2b71949370",
18 "vmName": "vm-i029wtci-0-m-xiangtan-f1gvv",
19 "status": "RUNNING",
20 "cpu": 1,
21 "mem": 2,
22 "gpu": 0,
23 "region": "CENTRAL_CHINA",
24 "city": "XIANGTAN",
25 "needPublicIp": true,
26 "needIpv6PublicIp": false,
27 "bandwidth": "100Mbps",
28 "osImage": {
29 "id": "49",
30 "imageId": "im-awwxnhme-2-u-huhehaote",
31 "name": "勿删-helloworld",
32 "imageType": "becCustom",
33 "snapshotId": null,
34 "cpu": 0,
35 "memory": 0,
36 "osType": "linux",
37 "osVersion": "7.3",
38 "osName": "CentOS",
39 "osBuild": "2020122100",
40 "osLang": "ENG",
41 "diskSize": 0,
42 "createTime": "2021-01-25T13:30:02Z",
43 "status": null,
44 "minMem": 0,
45 "minCpu": 0,
46 "minDiskGb": 0,
47 "desc": null,
48 "osArch": "x86_64 (64bit)",
49 "ephemeralSize": 0,
50 "imageDescription": null,
51 "shareToUserNumLimit": 0,
52 "sharedToUserNum": 0,
53 "fpgaType": null,
54 "name_fri": null
55 },
56 "serviceId": "s-i029wtci",
57 "createTime": "2021-03-01T10:34:06Z",
58 "rootDiskSize": 40,
59 "dataStorage": 43,
60 "systemVolume": {
61 "volumeType": "SATA",
62 "sizeInGB": 40,
63 "name": "vm-rootfs",
64 "pvcName": "lvm-i029wtci-0-m-xiangtan-f1gvv-rootfs"
65 },
66 "dataVolumeList": [
67 {
68 "name": "volume1",
69 "volumeType": "NVME",
70 "sizeInGB": 21,
71 "pvcName": "lvm-i029wtci-0-m-xiangtan-f1gvv-0ya7f"
72 }
73 ]
74 }
75}
Model对象定义
VmInstanceDetailsVo
参数名称 | 类型 | 描述 |
---|---|---|
vmId | String | 虚机实例ID |
uuId | String | 虚机实例ID |
vmName | String | 虚机实例名称 |
status | String | 资源状态(CREATING、RUNNING、STOPPING、STOPPED、RESTARTING、REINSTALLING、STARTING、IMAGING、FAILED、UNKNOWN) |
cpu | Integer | CPU数量 |
mem | Integer | 内存数量 |
gpu | Integer | GPU数量 |
rootDiskSize | Integer | 系统盘数量 |
dataStorage | Integer | 数据盘数量 |
region | String | 地域 |
serviceProvider | String | 运营商 |
city | String | 城市 |
needPublicIp | boolean | 是否开通公网 |
needIpv6PublicIp | boolean | 是否开通IPv6公网 |
multiplePublicIp | List<IpInfo> | 三线公网IP |
ipv6PublicIp | String | IPv6公网IP |
internalIp | String | 内网IP |
bandwidth | String | 公网带宽大小 |
bandwidth | String | 公网带宽大小 |
osImage | ImageDetail | 系统镜像详情 |
serviceId | String | 虚机服务ID |
createTime | Date | 创建时间 |
systemVolume | SystemVolumeConfig | 系统盘 |
dataVolumeList | List<VolumeConfig> | 数据盘列表 |
KeyConfig
参数名称 | 类型 | 描述 |
---|---|---|
type | String | 类型,bccKeyPair为选择密钥对,password为选择的密码 |
bccKeyPairIdList | List<String> | 虚机密钥对ID列表 |
adminPass | String | 虚机密码限制长度为8~32位字符,英文、数字和符号必须同时存在,符号仅限!@#$%^+*() |
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 |
SystemVolumeConfig
参数名称 | 类型 | 描述 |
---|---|---|
volumeType | DiskType | 盘类型 |
sizeInGB | Integer | 盘尺寸 |
name | String | 盘名称 |
pvcName | String | PVC名称 |
VolumeConfig
参数名称 | 类型 | 描述 |
---|---|---|
volumeType | DiskType | 盘类型 |
sizeInGB | Integer | 盘尺寸 |
name | String | 盘名称 |
pvcName | String | PVC 名称 |
IpInfo
参数名称 | 类型 | 描述 |
---|---|---|
serviceProvider | ServiceProvider | 运营商 |
ip | String | 公网IP |
ipv6 | String | 公网IPv6 |
ServiceProvider
编码 | 描述 |
---|---|
CHINA_MOBILE | 中国移动 |
CHINA_UNICOM | 中国联通 |
CHINA_TELECOM | 中国电信 |
TRIPLE_LINE | 三线 |
INTRA | 内网 |