获取BEC虚机镜像列表
更新时间：2025-01-09
接口描述
本接口用于获取BEC虚机自定义镜像列表、公共镜像列表。
请求结构
Plain Text
1GET /v1/vm/image HTTP/1.1
2Host: bec.baidubce.com
3Content-Type: application/json; charset=utf-8
4Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| pageNo | Integer | 否 | Query参数 | 页数，缺省值为1 |
| pageSize | Integer | 否 | Query参数 | 每页个数，取值范围1～1000，缺省值为1000 |
| keywordType | String | 否 | Query参数 | 查询类型，取值范围为imageId、name，分别表示镜像Id、镜像名字 |
| keyword | String | 否 | Query参数 | 查询的关键字，即对应查询类型的具体字段。 |
| order | String | 否 | Query参数 | 排序，取值为ASC、DESC，分别表示升序、降序 |
| orderBy | String | 否 | Query参数 | 排序字段取值为createTime、systemDisk，分别表示镜像创建时间、系统盘大小 |
| status | String | 否 | Query参数 | 状态筛选(SUCCEEDED,IMAGING) |
| osName | String | 否 | Query参数 | 操作系统名称筛取值为CentOS、Ubuntu、Debian、opensuse |
| type | String | 否 | Query参数 | 镜像类型（becCommon公共镜像，becCustom私有镜像）。不传该参数缺省为becCustom |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | List<VmImageVo> | 列表数据 |
| orderBy | String | 排序字段 |
| order | String | 排序，取值为ASC、DESC，分别表示升序、降序 |
| pageNo | Integer | 页码 |
| pageSize | Integer | 每页结果数 |
| totalCount | Integer | 结果总数 |
错误码
请参照错误返回章节的内容。
请求示例
Plain Text
1GET /v1/vm/image?type=becCommon HTTP/1.1
2Host: bec.baidubce.com
3Content-Type: application/json; charset=utf-8
4Authorization: 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"result": {
9 "order": "desc",
10 "orderBy": "createTime",
11 "orders": null,
12 "pageNo": 1,
13 "pageSize": 1000,
14 "result": [{
15 "accountId": "becCommon",
16 "bccImageId": "im-DSzFfneF",
17 "createTime": "2021-04-22T02:49:33Z",
18 "imageId": "im-DSzFfneF",
19 "imageType": "becCommon",
20 "name": "centos7.1",
21 "osArch": "x86_64 (64bit)",
22 "osBuild": "2020122100",
23 "osLang": "ENG",
24 "osName": "CentOS",
25 "osType": "linux",
26 "osVersion": "7.1",
27 "status": null,
28 "systemDisk": 40,
29 "updateTime": "2021-04-27T03:56:49Z"
30 }, {
31 "accountId": "becCommon",
32 "bccImageId": "im-IqkgobHQ",
33 "createTime": "2021-04-22T09:23:26Z",
34 "imageId": "im-IqkgobHQ",
35 "imageType": "becCommon",
36 "name": "centos7.2",
37 "osArch": "x86_64 (64bit)",
38 "osBuild": "2020122100",
39 "osLang": "ENG",
40 "osName": "CentOS",
41 "osType": "linux",
42 "osVersion": "7.2",
43 "status": null,
44 "systemDisk": 40,
45 "updateTime": "2021-04-27T03:56:48Z"
46 }, {
47 "accountId": "becCommon",
48 "bccImageId": "im-LcSjEXvD",
49 "createTime": "2021-04-22T11:11:36Z",
50 "imageId": "im-LcSjEXvD",
51 "imageType": "becCommon",
52 "name": "centos7.3",
53 "osArch": "x86_64 (64bit)",
54 "osBuild": "2020122100",
55 "osLang": "ENG",
56 "osName": "CentOS",
57 "osType": "linux",
58 "osVersion": "7.3",
59 "status": null,
60 "systemDisk": 40,
61 "updateTime": "2021-04-27T03:56:48Z"
62 }, {
63 "accountId": "becCommon",
64 "bccImageId": "im-dNgl59ys",
65 "createTime": "2021-04-22T12:30:09Z",
66 "imageId": "im-dNgl59ys",
67 "imageType": "becCommon",
68 "name": "centos7.4",
69 "osArch": "x86_64 (64bit)",
70 "osBuild": "2020122100",
71 "osLang": "ENG",
72 "osName": "CentOS",
73 "osType": "linux",
74 "osVersion": "7.4",
75 "status": null,
76 "systemDisk": 40,
77 "updateTime": "2021-04-27T03:56:48Z"
78 }, {
79 "accountId": "becCommon",
80 "bccImageId": "im-DqQdV8VQ",
81 "createTime": "2021-04-22T12:30:09Z",
82 "imageId": "im-DqQdV8VQ",
83 "imageType": "becCommon",
84 "name": "centos7.5",
85 "osArch": "x86_64 (64bit)",
86 "osBuild": "2020122100",
87 "osLang": "ENG",
88 "osName": "CentOS",
89 "osType": "linux",
90 "osVersion": "7.5",
91 "status": null,
92 "systemDisk": 40,
93 "updateTime": "2021-04-27T03:56:48Z"
94 }, {
95 "accountId": "becCommon",
96 "bccImageId": "im-eBHbN3gg",
97 "createTime": "2021-04-22T12:30:11Z",
98 "imageId": "im-eBHbN3gg",
99 "imageType": "becCommon",
100 "name": "centos7.6",
101 "osArch": "x86_64 (64bit)",
102 "osBuild": "2020122100",
103 "osLang": "ENG",
104 "osName": "CentOS",
105 "osType": "linux",
106 "osVersion": "7.6",
107 "status": null,
108 "systemDisk": 40,
109 "updateTime": "2021-04-27T03:56:48Z"
110 }, {
111 "accountId": "becCommon",
112 "bccImageId": "im-3kKaN3vb",
113 "createTime": "2021-04-22T07:21:19Z",
114 "imageId": "im-3kKaN3vb",
115 "imageType": "becCommon",
116 "name": "debian9.1.0",
117 "osArch": "amd64 (64bit)",
118 "osBuild": "2020122100",
119 "osLang": "ENG",
120 "osName": "Debian",
121 "osType": "linux",
122 "osVersion": "9.1.0",
123 "status": null,
124 "systemDisk": 40,
125 "updateTime": "2021-04-26T14:28:05Z"
126 }, {
127 "accountId": "becCommon",
128 "bccImageId": "im-iYHEjowb",
129 "createTime": "2021-04-22T08:34:09Z",
130 "imageId": "im-iYHEjowb",
131 "imageType": "becCommon",
132 "name": "debian9.9.0",
133 "osArch": "amd64 (64bit)",
134 "osBuild": "2020122100",
135 "osLang": "ENG",
136 "osName": "Debian",
137 "osType": "linux",
138 "osVersion": "9.9.0",
139 "status": null,
140 "systemDisk": 40,
141 "updateTime": "2021-04-26T14:28:59Z"
142 }, {
143 "accountId": "becCommon",
144 "bccImageId": "im-IgMe2uwt",
145 "createTime": "2021-04-22T06:03:25Z",
146 "imageId": "im-IgMe2uwt",
147 "imageType": "becCommon",
148 "name": "ubuntu16.04",
149 "osArch": "amd64 (64bit)",
150 "osBuild": "2020122100",
151 "osLang": "ENG",
152 "osName": "Ubuntu",
153 "osType": "linux",
154 "osVersion": "16.04 LTS",
155 "status": null,
156 "systemDisk": 40,
157 "updateTime": "2021-04-27T03:56:41Z"
158 }, {
159 "accountId": "becCommon",
160 "bccImageId": "im-1MGfmLNt",
161 "createTime": "2021-04-22T07:58:39Z",
162 "imageId": "im-1MGfmLNt",
163 "imageType": "becCommon",
164 "name": "ubuntu18.04",
165 "osArch": "amd64 (64bit)",
166 "osBuild": "2020122100",
167 "osLang": "ENG",
168 "osName": "Ubuntu",
169 "osType": "linux",
170 "osVersion": "18.04 LTS",
171 "status": null,
172 "systemDisk": 40,
173 "updateTime": "2021-04-27T03:56:41Z"
174 }],
175 "totalCount": 10
176},
177"success": true
178}Model对象定义
VmImageVo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| imageId | String | 虚机镜像ID |
| name | String | 虚机镜像名称 |
| status | String | 虚机自定义镜像状态(IMAGING，SUCCEEDED)。 公共镜像不适用 |
| bccImageId | String | 基准镜像ID |
| beingUsed | Boolean | 自定义镜像是否有VM使用。公共镜像不适用。 |
| beingUsedVmList | List<VmInstanceImageVo> | 正在使用该自定义镜像的VM列表。公共镜像不适用 |
| imageType | String | 镜像类型：自定义镜像becCustom 、BEC公共镜像becCommon |
| systemDisk | Integer | 系统盘大小 |
| osType | String | 操作系统类型，linux、windows |
| osVersion | String | 操作系统版本 |
| osName | String | 操作系统名称 |
| osBuild | String | 基准镜像构建时间 |
| osLang | String | 操作系统语言 |
| osArch | String | 操作系统处理器架构 |
| preheatingNodeList | List<PreheatingNodeVo> | 已预热的边缘节点列表 |
| createTime | String | 创建时间 |
| updateTime | String | 更新时间 |
VmInstanceImageVo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| vmId | String | 虚机ID |
| vmName | String | 虚机名称 |
PreheatingNodeVo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| regionId | String | 节点ID |
| status | String | 状态：已预热Cached，预热中Pulling |