获取BEC虚机实例列表
更新时间：2025-01-07
接口描述
本接口用于获取BEC虚机实例列表。
请求结构
Plain Text
1GET /v1/vm/instance?pageNo={pageNo}&pageSize={pageSize}&keywordType={keywordType}&keyword={keyword} HTTP/1.1
2Host: bec.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| pageNo | Integer | 否 | Query参数 | 页数，缺省值为1 |
| pageSize | Integer | 否 | Query参数 | 每每页容器服务个数，取值范围为1～100，缺省值为100 |
| keywordType | String | 否 | Query参数 | 查询实例的关键字类型，取值为instanceId、serviceId、instanceName、instanceIp、securityGroupId、deploysetId, 分别表示实例ID、服务ID、实例名字、实例IP、 安全组ID、部署集ID |
| keyword | String | 否 | Query参数 | 查询实例的关键字 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | List<VmInstanceDetailsVo> | 列表数据 |
| orderBy | String | 排序字段 |
| order | String | 排序顺序 |
| pageNo | Integer | 页码 |
| pageSize | Integer | 每页结果数 |
| totalCount | Integer | 结果总数 |
错误码
请参照错误返回章节的内容。
请求示例
Plain Text
1GET /v1/vm/instance?pageNo=1&pageSize=10&keyword=&keywordType=instanceId HTTP/1.1
2Host: bec.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de响应示例
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 "order":null,
9 "orderBy":null,
10 "orders":null,
11 "pageNo":1,
12 "pageSize":10,
13 "result":[
14 {
15 "publicIp": "112.29.149.223",
16 "ipv6PublicIp": "",
17 "internalIp": null,
18 "multiplePublicIp": null,
19 "serviceProvider": "CHINA_MOBILE",
20 "vmId": "vm-imwcjdtr",
21 "uuid": "askj1293-b8e5-4fcf-u7a1-dd2b71949370",
22 "vmName": "vm-imwcjdtr",
23 "status": "RUNNING",
24 "cpu": 1,
25 "mem": 2,
26 "gpu": 0,
27 "region": "CENTRAL_CHINA",
28 "city": "XIANGTAN",
29 "needPublicIp": true,
30 "needIpv6PublicIp": false,
31 "bandwidth": "100Mbps",
32 "osImage": {
33 "id": "49",
34 "imageId": "im-awwxnhme-2-u-asknfjnwe",
35 "name": "test-image",
36 "imageType": "becCustom",
37 "snapshotId": null,
38 "spec": "bec.g2.c1m4",
39 "cpu": 0,
40 "memory": 0,
41 "osType": "linux",
42 "osVersion": "7.3",
43 "osName": "CentOS",
44 "osBuild": "2020122100",
45 "osLang": "ENG",
46 "diskSize": 0,
47 "createTime": "2021-01-25T13:30:02Z",
48 "status": null,
49 "minMem": 0,
50 "minCpu": 0,
51 "minDiskGb": 0,
52 "desc": null,
53 "osArch": "x86_64 (64bit)",
54 "ephemeralSize": 0,
55 "imageDescription": null,
56 "shareToUserNumLimit": 0,
57 "sharedToUserNum": 0,
58 "fpgaType": null,
59 "name_fri": null
60 },
61 "serviceId": "s-12kjnd19",
62 "rackId": "rk-9059xxxf",
63 "hostId": "h-6660xxx3",
64 "switchId": "sw-d021xxxa",
65 "privateIps":[],
66 "createTime": "2021-03-01T10:34:06Z",
67 "rootDiskSize": 40,
68 "dataStorage": 43,
69 "systemVolume": {
70 "volumeType": "SATA",
71 "sizeInGB": 40,
72 "name": "vm-rootfs",
73 "pvcName": "lvm-12kjnd19-0-m-xiangtan-knj12-rootfs"
74 }，
75 "dataVolumeList": [
76 {
77 "name": "volume1",
78 "volumeType": "NVME",
79 "sizeInGB": 21,
80 "pvcName": "lvm-12kjnd19-0-m-xiangtan-knj12-2n1le"
81 }
82 ],
83 "securityGroups": [
84 {
85 "id": "sg-mkvivalw",
86 "name": "default",
87 "desc": "test"
88 }
89 ],
90 "vpc": {
91 "vpcId": "vpc-djn3wxpu",
92 "name": "vpc-test",
93 "cidr": "192.168.0.0/16",
94 "description": "",
95 "subnet": {
96 "subnetId": "sbn-lv6crppu",
97 "name": "subnet-test",
98 "cidr": "192.168.0.0/16",
99 "description": ""
100 }
101 },
102 "deploysetList": [
103 {
104 "deploysetId": "dset-enckow4i",
105 "name": "部署集"
106 }
107 ]
108 },
109 {
110 "bandwidth": "100Mbps",
111 "bccKeyPairList": null,
112 "city": "BAODING",
113 "cpu": 1,
114 "createTime": "2021-05-06T09:50:29Z",
115 "dataStorage": 0,
116 "dataVolumeList": [],
117 "gpu": 0,
118 "hostId": "h-44e6exxx",
119 "internalIp": "172.16.3.14",
120 "ipv6PublicIp": null,
121 "mem": 2,
122 "multiplePublicIp": [{
123 "ip": "124.237.214.127",
124 "ipv6": "",
125 "serviceProvider": "CHINA_TELECOM"
126 }, {
127 "ip": "119.249.103.127",
128 "ipv6": "",
129 "serviceProvider": "CHINA_UNICOM"
130 }, {
131 "ip": "111.63.78.127",
132 "ipv6": "",
133 "serviceProvider": "CHINA_MOBILE"
134 }],
135 "needIpv6PublicIp": false,
136 "needPublicIp": true,
137 "osImage": {
138 "cpu": 0,
139 "createTime": "2020-12-22T02:31:51Z",
140 "desc": "ubuntu-18.04-amd64-20201218155248",
141 "diskSize": 0,
142 "ephemeralSize": 0,
143 "fpgaType": "",
144 "id": "c40c73c3-8ea2-49b3-8658-88fc8d353355",
145 "imageDescription": "ubuntu-18.04-amd64-20201218155248",
146 "imageId": "m-hjTVHVLu",
147 "imageType": "common",
148 "memory": 0,
149 "minCpu": 0,
150 "minDiskGb": 20,
151 "minMem": 1,
152 "name": "ubuntu-18.04-amd64-20201218155248",
153 "name_fri": null,
154 "osArch": "amd64 (64bit)",
155 "osBuild": "2020122100",
156 "osLang": "ENG",
157 "osName": "Ubuntu",
158 "osType": "linux",
159 "osVersion": "18.04 LTS",
160 "shareToUserNumLimit": 0,
161 "sharedToUserNum": 0,
162 "snapshotId": "",
163 "status": "active"
164 },
165 "privateIps": [],
166 "publicIp": null,
167 "rackId": "rk-41fa9xxx",
168 "region": "NORTH_CHINA",
169 "rootDiskSize": 40,
170 "serviceId": "s-pj3dxxxx",
171 "serviceProvider": "TRIPLE_LINE",
172 "status": "RUNNING",
173 "switchId": "sw-953f8xxx",
174 "systemVolume": {
175 "name": "sys",
176 "pvcName": "lvm-pj3dxizf-2-l-baoding-hmeci-rootfs",
177 "sizeInGB": 40,
178 "volumeType": "NVME"
179 },
180 "uuid": "6b418f82-c85d-4d85-857b-6ce5b5f8e0dc",
181 "vmId": "vm-pj3dxizf-2-l-baoding-hmeci",
182 "vmName": "vm-pj3dxizf-2-l-baoding-hmeci",
183 "tags": [
184 {
185 "tagKey": "tagKey",
186 "tagValue": "tagValue"
187 }
188 ]
189 }
190 ],
191 "totalCount":2
192}Model对象定义
VmInstanceDetailsVo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| 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时有效。 |
| deploysetList | List<DeploySetVo> | 部署集信息列表。 |
| tags | List<TagModel> | 标签信息 |
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 | 内网 |
| BGP | BGP |
SecurityGroup
| 参数名称 | 类型 | 描述 |
|---|---|---|
| id | String | 安全组ID |
| name | String | 名称 |
| desc | 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 | 标签值 |