获取云桌面镜像列表
更新时间：2024-01-26
获取云桌面镜像列表
接口描述
本接口用于获取云桌面镜像列表。
请求结构
GET /v1/bvd/images{?gpuMode,imageType,pageNo,pageSize}
Host: bec.baidubce.com
Authorization: authorization string
X-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 |
错误码
请参照错误返回章节的内容。
请求示例
GET /v1/bvd/images HTTP/1.1
Host: bec.baidubce.com
Authorization: bce-auth-v1/xxxxx响应示例
{
"isTruncated": false,
"totalCount": 2,
"pageSize": 1000,
"pageNo": 1,
"result": [
{
"imageId": "m-DIdl4PSF",
"name": "windows10",
"imageType": "system",
"size": 50,
"osType": "Windows",
"osName": "windows",
"gpuMode": ""
},
{
"imageId": "im-k0cq2ivz",
"name": "window-test",
"imageType": "custom",
"size": 40,
"osType": "windows",
"osName": "Windows",
"gpuMode": ""
}
]
}