获取BEC虚机镜像列表
更新时间：2023-07-27
接口描述
本接口用于获取BEC虚机镜像列表。
请求结构
Plain Text
1GET /v2/vm/image?imageName={imageName}&imageType={imageType}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
2Host: bec.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| imageType | 虚机镜像类型。becCommon：BEC公共镜像；becGpu：BEC GPU镜像；becCustom：BEC自定义镜像。 | query | 是 | string |
| imageId | 指定虚机镜像ID | query | 否 | string |
| imageName | 指定虚机镜像名称 | query | 否 | string |
| marker | 标记查询的起始位置 | query | 否 | string |
| maxKeys | 每页包含的最大数量，1-1000，默认1000 | query | 否 | integer |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 参数说明 | 类型 |
|---|---|---|
| images | 虚机镜像列表 | List<BecVmImageModel> |
| createTime | 创建时间 | string |
| imageId | 虚机镜像ID | string |
| imageName | 虚机镜像名称 | string |
| imageType | 虚机镜像类型 | string |
| osArch | 操作系统处理器架构 | string |
| osBuild | 镜像构建时间 | string |
| osLang | 操作系统语言 | string |
| osName | 操作系统名称 | string |
| osType | 操作系统类型 | string |
| osVersion | 操作系统版本 | string |
| status | 虚机镜像状态。镜像制作中：IMAGING；镜像制作完成：SUCCEEDED; 删除中：DELETING；镜像导入中：IMPORTING；导入错误：ERROR；失败：FAILED | string |
| isTruncated | true表示后面还有数据，false表示已经是最后一页 | boolean |
| marker | 标记查询的起始位置 | string |
| maxKeys | 每页包含的最大数量 | integer |
| nextMarker | 获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现 | string |
错误码
请参照错误返回章节的内容。
请求示例
Plain Text
1GET /v2/vm/image?imageType=becCustom 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 "marker": null,
9 "isTruncated": false,
10 "nextMarker": null,
11 "maxKeys": 1000,
12 "images": [
13 {
14 "imageId": "im-6nofjr4s-1-m-hangzhou",
15 "imageName": "becimage_test",
16 "imageType": "becCustom",
17 "osType": "linux",
18 "osVersion": "7.3",
19 "osArch": "x86_64 (64bit)",
20 "osName": "CentOS",
21 "osBuild": "2020111300",
22 "osLang": "ENG",
23 "status": "SUCCEEDED",
24 "createTime": "2021-12-20T17:26:07Z"
25 }
26 ]
27}