获取BEC虚机实例详情
更新时间:2021-03-03
接口描述
本接口用于获取BEC虚机实例详情
请求结构
GET /v1/vm/instance/{vmID} HTTP/1.1
Host: bec.baidubce.com
Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
vmID | String | 是 | URL参数 | 虚机实例id |
响应头域
除公共头域外,无其它特殊头域。
响应参数
参数名称 | 类型 | 描述 |
---|---|---|
vmId | String | 虚机实例ID |
uuId | String | 虚机实例ID |
vmName | String | 虚机实例名称 |
status | String | 资源状态(STOP,RUNNING,PENDING,TERMINATING,FAILED,SUCCEEDED,UNKNOWN,TERMINATED,WAITING) |
cpu | int | cpu数量 |
mem | int | 内存数量 |
gpu | int | gpu数量 |
rootDiskSize | int | 系统盘数量 |
dataStorage | int | 数据盘数量 |
region | String | 地域 |
serviceProvider | String | 运营商 |
city | String | 城市 |
needPublicIp | boolean | 是否开通公网 |
needIpv6PublicIp | boolean | 是否开通ipv6公网 |
multiplePublicIp | List |
三线公网ip |
ipv6PublicIp | String | ipv6公网ip |
internalIp | String | 内网ip |
bandwidth | String | 公网带宽大小 |
bandwidth | String | 公网带宽大小 |
osImage | ImageDetail | 系统镜像详情 |
serviceId | String | 虚机服务id |
createTime | Date | 创建时间 |
systemVolume | SystemVolumeConfig | 系统盘 |
dataVolumeList | List |
数据盘列表 |
错误码
请参照前文的统一错误码和平台错误码。
请求示例
GET /v1/vm/instance/vm-imwcjdtr HTTP/1.1
Host: bec.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
响应示例
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
{
"publicIp": "112.29.149.223",
"ipv6PublicIp": "",
"internalIp": null,
"multiplePublicIp": null,
"serviceProvider": "CHINA_MOBILE",
"vmId": "vm-imwcjdtr",
"uuid": "askj1293-b8e5-4fcf-u7a1-dd2b71949370",
"vmName": "vm-imwcjdtr",
"status": "RUNNING",
"cpu": 1,
"mem": 2,
"gpu": 0,
"region": "CENTRAL_CHINA",
"city": "XIANGTAN",
"needPublicIp": true,
"needIpv6PublicIp": false,
"bandwidth": "100Mbps",
"osImage": {
"id": "49",
"imageId": "im-awwxnhme-2-u-asknfjnwe",
"name": "test-image",
"imageType": "becCustom",
"snapshotId": null,
"cpu": 0,
"memory": 0,
"osType": "linux",
"osVersion": "7.3",
"osName": "CentOS",
"osBuild": "2020122100",
"osLang": "ENG",
"diskSize": 0,
"createTime": "2021-01-25T13:30:02Z",
"status": null,
"minMem": 0,
"minCpu": 0,
"minDiskGb": 0,
"desc": null,
"osArch": "x86_64 (64bit)",
"ephemeralSize": 0,
"imageDescription": null,
"shareToUserNumLimit": 0,
"sharedToUserNum": 0,
"fpgaType": null,
"name_fri": null
},
"serviceId": "s-12kjnd19",
"createTime": "2021-03-01T10:34:06Z",
"rootDiskSize": 40,
"dataStorage": 43,
"systemVolume": {
"volumeType": "SATA",
"sizeInGB": 40,
"name": "vm-rootfs",
"pvcName": "lvm-12kjnd19-0-m-xiangtan-knj12-rootfs"
},
"dataVolumeList": [
{
"name": "volume1",
"volumeType": "NVME",
"sizeInGB": 21,
"pvcName": "lvm-12kjnd19-0-m-xiangtan-knj12-2n1le"
}
]
}
Model对象定义
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 |
SystemVolumeConfig
参数名称 | 类型 | 描述 |
---|---|---|
volumeType | DiskType | 盘类型 |
sizeInGB | int | 盘尺寸 |
name | String | 盘名称 |
pvcName | String | pvc名称 |
VolumeConfig
参数名称 | 类型 | 描述 |
---|---|---|
volumeType | DiskType | 盘类型 |
sizeInGB | int | 盘尺寸 |
name | String | 盘名称 |
pvcName | String | pvc名称 |