获取BEC虚机实例详情
更新时间：2025-01-07
接口描述
本接口用于获取BEC虚机实例详情。
请求结构
Plain Text
1GET /v1/vm/instance/{vmId} HTTP/1.1
2Host: bec.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| vmId | String | 是 | URL参数 | 虚机实例ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| vmId | String | 虚机实例ID |
| uuId | String | 虚机实例ID |
| vmName | String | 虚机实例名称 |
| status | String | 资源状态(CREATING，RUNNING，STOPPING，STOPPED，RESTARTING，REINSTALLING，STARTING，IMAGING，FAILED，UNKNOWN) |
| spec | String | 分机型策略虚机规格族 |
| cpu | Integer | CPU数量 |
| mem | Integer | 内存数量 |
| gpu | Integer | GPU数量 |
| rootDiskSize | Integer | 系统盘数量 |
| dataStorage | Integer | 数据盘数量 |
| regionId | String | 节点ID |
| region | String | 地域 |
| serviceProvider | String | 运营商 |
| city | String | 城市 |
| needPublicIp | Boolean | 是否开通公网 |
| needIpv6PublicIp | Boolean | 是否开通IPv6公网 |
| multiplePublicIp | List<IpInfo> | 三线公网IP |
| ipv6PublicIp | String | IPv6公网IP |
| internalIp | String | 内网IP |
| bandwidth | String | 公网带宽大小 |
| osImage | ImageDetail | 系统镜像详情 |
| serviceId | String | 虚机服务ID |
| createTime | Date | 创建时间 |
| systemVolume | SystemVolumeConfig | 系统盘 |
| dataVolumeList | List<VolumeConfig> | 数据盘列表 |
| rackId | String | 宿主机所在机架ID（白名单用户提供） |
| hostId | String | 宿主机ID（白名单用户提供） |
| switchId | String | 宿主机所在交换机ID（白名单用户提供） |
| privateIps | List<String> | 内网辅助IP列表 |
| securityGroups | List<SecurityGroup> | 虚机关联的安全组列表。当虚机的网络类型为vpc时有效 |
| vpc | Vpc | 虚机所属的私有网络和子网信息。当虚机的网络类型为vpc时有效 |
| networkConfig | NetworkConfig | 虚机网络名和IP地址列表 |
| deploysetList | List<DeploySetVo> | 部署集信息列表 |
| userData | String | 用户注入数据的base64编码. base64(user_injected_data: base64(原文)) |
| tags | List<TagModel> | 标签信息 |
错误码
请参照错误返回章节的内容。
请求示例
Plain Text
1GET /v1/vm/instance/vm-imwcjdtr HTTP/1.1
2Host: bec.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/hashkey响应示例
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 "publicIp": "112.29.149.223",
9 "ipv6PublicIp": "",
10 "internalIp": null,
11 "multiplePublicIp": null,
12 "serviceProvider": "CHINA_MOBILE",
13 "vmId": "vm-imwcjdtr",
14 "uuid": "askj1293-b8e5-4fcf-u7a1-dd2b71949370",
15 "vmName": "vm-imwcjdtr",
16 "status": "RUNNING",
17 "spec": "bec.c2.c1m2",
18 "cpu": 1,
19 "mem": 2,
20 "gpu": 0,
21 "regionId": "cn-xiangtan-cm",
22 "region": "CENTRAL_CHINA",
23 "city": "XIANGTAN",
24 "needPublicIp": true,
25 "needIpv6PublicIp": false,
26 "bandwidth": "100Mbps",
27 "osImage": {
28 "id": "49",
29 "imageId": "im-awwxnhme-2-u-asknfjnwe",
30 "name": "test-image",
31 "imageType": "becCustom",
32 "snapshotId": null,
33 "cpu": 0,
34 "memory": 0,
35 "osType": "linux",
36 "osVersion": "7.3",
37 "osName": "CentOS",
38 "osBuild": "2020122100",
39 "osLang": "ENG",
40 "diskSize": 0,
41 "createTime": "2021-01-25T13:30:02Z",
42 "status": null,
43 "minMem": 0,
44 "minCpu": 0,
45 "minDiskGb": 0,
46 "desc": null,
47 "osArch": "x86_64 (64bit)",
48 "ephemeralSize": 0,
49 "imageDescription": null,
50 "shareToUserNumLimit": 0,
51 "sharedToUserNum": 0,
52 "fpgaType": null,
53 "name_fri": null
54 },
55 "serviceId": "s-12kjnd19",
56 "rackId": "rk-9059xxxf",
57 "hostId": "h-6660xxx3",
58 "switchId": "sw-d021xxxa",
59 "privateIps":[],
60 "createTime": "2021-03-01T10:34:06Z",
61 "rootDiskSize": 40,
62 "dataStorage": 43,
63 "systemVolume": {
64 "volumeType": "SATA",
65 "sizeInGB": 40,
66 "name": "vm-rootfs",
67 "pvcName": "lvm-12kjnd19-0-m-xiangtan-knj12-rootfs"
68 },
69 "dataVolumeList": [
70 {
71 "name": "volume1",
72 "volumeType": "NVME",
73 "sizeInGB": 21,
74 "pvcName": "lvm-12kjnd19-0-m-xiangtan-knj12-2n1le"
75 }
76 ],
77 "networkConfig": {
78 "nodeType": "SINGLE",
79 "networksList": [
80 {
81 "netType": "INTERNAL_IP",
82 "netName": "testeth1",
83 "eniId": "nic-12kjnd19-1",
84 "nicIndex": 0,
85 "ipv4": {
86 "ip": "10.1.0.100"
87 },
88 "ipv6": {
89 "ip": ""
90 },
91 "reserveIps": null
92 },
93 {
94 "netType": "PUBLIC_IP",
95 "netName": "testeth2",
96 "eniId": "nic-12kjnd19-2",
97 "nicIndex": 1,
98 "ipv4": {
99 "ip": "xxx.xxx.xxx.xxx"
100 },
101 "ipv6": {
102 "ip": ""
103 },
104 "reserveIps": null
105 }
106 ],
107 "needPrivateNetwork": true,
108 "needPublicNetwork": true,
109 "privateNetworkName": "testeth1",
110 "publicNetworkName": "testeth2"
111 },
112 "vpc": {
113 "vpcId": "vpc-djn3wxpu",
114 "name": "vpc-test",
115 "cidr": "192.168.0.0/16",
116 "description": "test",
117 "subnet": {
118 "subnetId": "sbn-lv6crppu",
119 "name": "subnet-test",
120 "cidr": "192.168.0.0/20",
121 "description": "test"
122 }
123 },
124 "securityGroups": [
125 {
126 "id": "sg-mkvivalw",
127 "name": "default",
128 "desc": "test",
129 "rules": [
130 {
131 "securityGroupRuleId": "sgr-mkvivalw-cjgy7clg",
132 "direction": "egress",
133 "protocol": "all",
134 "portRange": "1-65535",
135 "remark": "default",
136 "etherType": "IPv4",
137 "destIp": "0.0.0.0/0"
138 },
139 {
140 "securityGroupRuleId": "sgr-mkvivalw-zqpec2tj",
141 "direction": "ingress",
142 "protocol": "tcp",
143 "portRange": "22",
144 "remark": "SSH远程终端",
145 "etherType": "IPv4",
146 "sourceIp": "0.0.0.0/0"
147 }
148 ]
149 }
150 ],
151 "deploysetList": [
152 {
153 "deploysetId": "dset-enckow4i",
154 "name": "部署集"
155 }
156 ],
157 userData": "dXNlcl9pbmplY3RlZF9kYXRhOiBJeUV2WW1sdUwySmhjMmdLYld0a2FYSWdMWEFnTDJodmJXVXZjSHBzQ21WamFHOGdJa2hsYkd4dkxDQlhiM0pzWkNFaUlENCtJQzlvYjIxbEwzQjZiQzl3ZW13dWJHOW4=",
158 "tags": [
159 {
160 "tagKey": "tagKey",
161 "tagValue": "tagValue"
162 }
163 ]
164 }Model对象定义
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名称 |
| passthroughCode | String | 独占盘套餐码 |
NetworkConfig
| 参数名称 | 类型 | 描述 |
|---|---|---|
| nodeType | NodeType | 节点类型(SINGLE表示单线节点、TRIPLE表示三线节点) |
| networksList | List<Networks> | 主网卡详情，包含Networks |
Networks
| 参数名称 | 类型 | 描述 |
|---|---|---|
| netType | String | 网卡类型 (INTERNAL_IP表示内网；单线节点使用PUBLIC_IP表示单线公网网卡；三线节点用TRIPLE_CT、TRIPLE_UN、TRIPLE_CM分别表示三线公网的电信、联通、移动) |
| netName | String | 网卡名称，内外网卡的名称不能重复；支持大小写字母，数字，"-_"，必须以字母开头，长度3-16字符。 |
| nicIndex | int | 网卡序号，从0开始 |
| eniId | String | 网卡ID （适用于VPC网络） |
| ipv4 | IpAddress | ipv4信息 |
| ipv6 | IpAddress | ipv6信息 |
| mac | String | 网卡MAC地址（白名单提供） |
| reserveIps | List<String> | 辅助IP列表 |
IpAddress
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ip | String | 公网IP |
IpInfo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| serviceProvider | ServiceProvider | 运营商 |
| ip | String | 公网IP |
| ipv6 | String | 公网IPv6 |
ServiceProvider
| 编码 | 描述 |
|---|---|
| CHINA_MOBILE | 中国移动 |
| CHINA_UNICOM | 中国联通 |
| CHINA_TELECOM | 中国电信 |
| TRIPLE_LINE | 三线 |
| BGP | BGP |
SecurityGroup
| 参数名称 | 类型 | 描述 |
|---|---|---|
| id | String | 安全组ID |
| name | String | 安全组名称 |
| desc | String | 安全组描述 |
| rules | List<SecurityGroupRule> | 安全组规则 |
SecurityGroupRule
| 参数名称 | 类型 | 描述 |
|---|---|---|
| direction | String | 入站/出站，取值ingress或egress。 |
| ethertype | String | 网络类型，取值IPv4。暂不支持IPv6 |
| portRange | String | 端口范围，单个端口，或者为1-65535格式的端口范围 |
| protocol | String | 协议类型，tcp、udp或icmp，值为空时指所有协议 |
| sourceIp | String | 源IP地址 |
| destIp | String | 目的IP地址 |
| remark | String | 备注 |
Vpc
| 参数名称 | 类型 | 描述 |
|---|---|---|
| vpcId | String | VPC ID |
| name | String | VPC名称 |
| cidr | String | VPC 网段及子网掩码CIDR |
| description | String | VPC 描述 |
| subnet | Subnet | 子网信息 |
Subnet
| 参数名称 | 类型 | 描述 |
|---|---|---|
| subnetId | String | 子网ID |
| name | String | 子网名称 |
| cidr | String | 子网网段CIDR |
| description | String | 子网描述 |
DeploySetVo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| deploysetId | String | 部署集ID |
| name | String | 部署集名称 |
TagModel
| 参数名称 | 类型 | 描述 |
|---|---|---|
| tagKey | String | 标签键 |
| tagValue | String | 标签值 |