创建自定义镜像
更新时间：2024-07-02
该接口用于创建自定义镜像，创建后的镜像可用于创建实例，每个用户单地域最多可拥有20个镜像。
- 支持通过实例创建和通过快照创建两种方式。
- 当通过实例创建时，只有 Running 或 Stopped 状态的实例才可以执行成功，否则会提示 409 错误。
- 仅限通过系统盘快照创建自定义镜像。
- 当通过快照创建时，只有 Available 状态的快照才可以执行成功，否则会提示 409 错误。
请求结构
POST /v{version}/image?clientToken={clientToken} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string
{
"imageName" : imageName,
"instanceId" : instanceId,
"snapshotId" : snapshotId,
"encryptKey": encryptKey,
"relateCds": relateCds
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| clientToken | String | 是 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串，详见幂等性。 |
| imageName | String | 是 | Request Body参数 | 待创建的自定义镜像名称，支持大小写字母、数字、中文以及-_ /.特殊字符，必须以字母开头，长度1-65。 |
| instanceId | String | 否 | Request Body参数 | 当从实例创建镜像时，此参数是指用于创建镜像的实例ID。可选参数，与 snapshotId 不同时存在，同时存在时只取instanceId |
| snapshotId | String | 否 | Request Body参数 | 当从快照创建镜像时，此参数是指用于创建镜像的快照ID。可选参数，与 instanceId 不同时存在，同时存在时只取instanceId |
| relateCds | boolean | 否 | RequestBody参数 | 是否创建包含了所有 cds 盘的大镜像，如果为true，镜像不能加密，且必须在白名单内 |
| encryptKey | String | 否 | RequestBody参数 | 加密密钥 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| 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 | 实例状态不是运行中或者已停止，请确认并重试 |
| Image.SnapshotStatusForbidden | Snapshot status is not Available, please confirm and retry. | 409 | 快照状态为不可用，请确认并重试 |
| Image.NonSystemSnapshotForbidden | Non system snapshot can not used to create image, please confirm and retry. | 403 | 非系统快照无法创建镜像 |
请求示例
POST /v2/image?clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849 HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
"imageName" : "template_example_001",
"instanceId":"i-1849ef6b"
}返回示例
HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS
{
"imageId" : "m-nky7qeom"
}