镜像相关接口
更新时间：2025-08-20
创建自定义镜像
- 该接口用于创建自定义镜像，默认配额20个每账号，创建后的镜像可用于实例重装系统。
- 只有 Running 或 Stopped 状态的实例才可以执行成功，否则会提示 409 错误。
请求结构
Plain Text
1POST /v{version}/image?clientToken={clientToken} HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "imageName" : imageName,
7 "instanceId" : instanceId
8}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| clientToken | String | 是 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串 |
| imageName | String | 是 | Request Body参数 | 待创建的自定义镜像名称，不能为空，且长度1~65，只能有字母、数字和中划线 |
| instanceId | String | 否 | Request Body参数 | 当从实例创建镜像时，此参数是指用于创建镜像的实例ID |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| imageId | String | 已创建的镜像的ID |
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| Image.ImageNameInvalid | Image name is invalid. | 400 | 镜像名称格式不正确 |
| Image.ImageIdIsEmpty | Image ID cannot be empty | 400 | 镜像ID格式不能为空 |
| Image.ImageQuotaExceedLimit | Image number exceeds the limit. | 413 | 镜像数目超限 |
| Image.InstanceStatusForbidden | Instance not in running or stopped status. | 409 | 实例状态不是运行中或者已停止，请确认并重试 |
请求示例
Plain Text
1POST /v1/image?clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849 HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6 "imageName" : "template_example_001",
7 "instanceId":"i-1849ef6b"
8}返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7{
8 "imageId" : "m-nky7qeom"
9}查询镜像列表
- 该接口用于查询用户所有的物理机镜像信息。
- 查询的镜像信息中包括系统镜像、自定义镜像和服务集成镜像。
- 支持按 imageType 来过滤查询，此参数非必需，缺省为 All,即查询所有类型的镜像。
请求结构
Plain Text
1GET /v{version}/image?marker={marker}&maxKeys={maxKeys}&imageType={imageType} HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| marker | String | 否 | Query参数 | 批量获取列表的查询的起始位置，是一个由系统生成的字符串 |
| maxKeys | int | 否 | Query参数 | 每页包含的最大数量，最大数量通常不超过1000。缺省值为1000 |
| imageType | String | 否 | Query参数 | 指定要查询何种类型的镜像，包括All(所有)，System(系统镜像/公共镜像)，Custom(自定义镜像)，Integration(服务集成镜像)，缺省值为All |
返回头域
除公共头域，无其它特殊头域
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| marker | String | 标记查询的起始位置 |
| isTruncated | boolean | true表示后面还有数据，false表示已经是最后一页。 |
| nextMarker | String | 获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现。 |
| maxKeys | int | 每页包含的最大数量 |
| images | List<ImageModel> | 返回的镜像列表 |
请求示例
Plain Text
1GET /v1/image?marker=m-nky7qeom&maxKeys=1 HTTP/1.1
2Host: bbc.bj.baidubce.com
3ContentType: application/json
4Date: Wed, 01 Mar 2006 12:00:00 GMT
5Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6{
7 "maxKeys":1,
8 "marker":"m-nky7qeom",
9 "isTruncated":true,
10 "nextMarker":"m-I88RTNWG",
11 "images":[
12 {
13 "id": "m-nky7qeom",
14 "createTime": "2015-06-17T10:37:02Z",
15 "name": "ubuntu-14.04.1-server-amd64-201506171832",
16 "type": "System",
17 "osType": "linux",
18 "osVersion": "14.04.1 LTS",
19 "osName": "Ubuntu",
20 "osBuild": "2015061700",
21 "osArch": "x86_64 (64bit)",
22 "status": "Available",
23 "desc": null
24 }
25 ]
26}查询镜像详情
- 该接口用于根据指定物理机镜像ID查询单个镜像的详细信息。
请求结构
Plain Text
1GET /v{version}/image/{imageId} HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| imageId | String | 是 | URL参数 | 待查询的镜像ID |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| id | String | 镜像ID |
| name | String | 镜像名称 |
| type | ImageType | 镜像类型 |
| osType | String | 操作系统类型 |
| osVersion | String | 操作系统版本 |
| osArch | String | 操作系统位数 |
| osName | String | 操作系统名称 |
| osBuild | String | 镜像操作系统的构建时间 |
| createTime | String | 镜像的创建时间，符合BCE规范的日期格式 |
| status | ImageStatus | 镜像状态 |
| desc | String | 镜像描述信息 |
请求示例
Plain Text
1GET /v1/image/m-nky7qeom HTTP/1.1
2Host: bbc.bj.baidubce.com
3ContentType: application/json
4Date: Wed, 01 Mar 2006 12:00:00 GMT
5Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7{
8 "id": "m-nky7qeom",
9 "createTime": "2015-06-17T10:37:02Z",
10 "name": "ubuntu-14.04.1-server-amd64-201506171832",
11 "type": "System",
12 "osType": "linux",
13 "osVersion": "14.04.1 LTS",
14 "osName": "Ubuntu",
15 "osBuild": "2015061700",
16 "osArch": "x86_64 (64bit)",
17 "status": "Available",
18 "desc": null
19}删除自定义镜像
- 该接口用于删除用户自己的指定的自定义镜像，仅限自定义镜像，系统镜像和服务集成镜像不能删除。
- imageId 所指定的镜像如果不存在，会提示404错误。
- 镜像删除后无法恢复，不能再用于创建、重置实例。
请求结构
Plain Text
1DELETE /v{version}/image/{imageId} HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| imageId | String | 是 | URL参数 | 待删除的镜像ID |
返回头域
除公共头域，无其它特殊头域。
返回参数
无特殊返回参数
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| Image.UnCustomImageCannotBeDeleted | Only custom image can be deleted. | 403 | 非自定义镜像不能删除 |
| Image.CreatingImageCannotBeDeleted | Cannot delete image when creating. | 409 | 创建中的镜像不能删除 |
请求示例
Plain Text
1DELETE /v1/image/m-nky7qeom HTTP/1.1
2Host: bbc.bj.baidubce.com
3ContentType: application/json
4Date: Wed, 01 Mar 2006 12:00:00 GMT
5Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS