获取云桌面镜像列表
更新时间:2025-08-05
获取云桌面镜像列表
接口描述
本接口用于获取云桌面镜像列表。
请求结构
JSON
1GET /v1/bvd/images{?gpuMode,imageType,pageNo,pageSize}
2Host: bec.baidubce.com
3Authorization: authorization string
4X-Bce-Accesskey: accesskey
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
pageNo | 页号 | query | false | integer | |
pageSize | 每页数量 1-1000 | query | false | integer | |
gpuMode | gpuMode, 值为pt:直通;vgpu:虚拟gpu | query | false | string | |
imageType | 镜像类型。system:公共镜像;custom:自定义镜像。 | query | false | string |
响应头域
除公共头域外,无其它特殊头域。
响应状态
状态码 | 说明 |
---|---|
200 | OK |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
响应参数
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
isTruncated | true表示后面还有数据,false表示已经是最后一页 | boolean | |
pageNo | 当前页号 | integer | |
pageSize | 每页数量,默认1000 | integer | |
totalCount | 总数 | integer | |
result | 镜像列表 | array | ImageVo |
gpuMode | 空表示非gpu类型,虚拟直通:vgpu, GPU直通:pt | string | |
imageId | 镜像ID | string | |
imageType | 镜像类型: 公共镜像:system, 自定义镜像:custom | string | |
name | 镜像名称 | string | |
osName | 操作系统名称 | string | |
osType | 操作系统类型 | string | |
size | 镜像占用磁盘大小,单位GB | integer |
错误码
请参照错误返回章节的内容。
请求示例
JSON
1GET /v1/bvd/images HTTP/1.1
2Host: bec.baidubce.com
3Authorization: bce-auth-v1/xxxxx
响应示例
JSON
1{
2 "isTruncated": false,
3 "totalCount": 2,
4 "pageSize": 1000,
5 "pageNo": 1,
6 "result": [
7 {
8 "imageId": "m-DIdl4PSF",
9 "name": "windows10",
10 "imageType": "system",
11 "size": 50,
12 "osType": "Windows",
13 "osName": "windows",
14 "gpuMode": ""
15 },
16 {
17 "imageId": "im-k0cq2ivz",
18 "name": "window-test",
19 "imageType": "custom",
20 "size": 40,
21 "osType": "windows",
22 "osName": "Windows",
23 "gpuMode": ""
24 }
25 ]
26}