导出镜像(新) - ExportImageInSafeMode
功能介绍
该接口为扩展接口,用于用户将自己的私有镜像导出到指定的OBS桶中。
导出镜像前请确保用户已拥有对象存储服务的Tenant Administrator权限。
约束限制
| 限制类别 | 具体限制 |
|---|---|
| 区域限制 | 仅支持导出到存储类别为标准存储的桶,并且桶和镜像在同一区域。 |
| 镜像类型限制 | 如下类型的私有镜像不允许导出:
说明:
|
| 镜像格式限制 |
|
| 镜像大小限制 | 镜像大小必须小于1TiB;大于128GiB且小于1TiB的镜像仅支持快速导出。镜像导出和快速导出的区别,请参见导入和快速导入、导出和快速导出功能对比。 说明: 部分区域支持导出的镜像大小上限可能大于128GiB,请以控制台实际操作提示为准。 |
| 时间限制 | 导出镜像所需时间取决于私有镜像大小和当前导出任务的并发数,需要您耐心等待。 |
| 费用相关 | 导出的镜像会产生一定的OBS存储费用。计费详情请参见“OBS的收费标准” 。 |
| 权限相关 | 加密镜像场景需要租户有KMS相关action权限。 |
调试
您可以在API Explorer中调试该接口。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v2.1/cloudimages/{image_id}/file
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| image_id | 是 | String | 参数解释: 镜像ID。如何获取镜像ID,请参见查询镜像列表 - ListImages。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求消息
- 请求参数
参数
是否必选
参数类型
描述
bucket_url
是
String
参数解释:
目的文件的URL,格式:<bucket>:<file>。
约束限制:
OBS桶和镜像文件的存储类别必须是标准存储
取值范围:
不涉及
默认取值:
不涉及
file_format
是
String
参数解释:
文件格式。
约束限制:
不涉及
取值范围:
支持qcow2、vhd、zvhd和vmdk。
默认取值:
不涉及
is_quick_export
否
Boolean
参数解释:
是否使用快速导出。
约束限制:
若使用快速导出,则无法指定file_format参数。导出的镜像文件格式为zvhd2。
取值范围:
取值为true或者false。
默认取值:
false
请求示例
导出镜像,其中,镜像文件格式为“qcow2”,目的文件的URL为“ims-image:centos7_5.qcow2”
1 2 3 4 5 6 | POST https://{Endpoint}/v2.1/cloudimages/d164b5df-1bc3-4c3f-893e-3e471fd16e64/file { "bucket_url": "ims-image:centos7_5.qcow2", "file_format": "qcow2", "is_quick_export": false } |
响应消息
- 响应参数
参数
参数类型
描述
job_id
String
参数解释:
异步任务ID。
详情请参见6.6.2-异步任务进度查询 - ShowJobProgress。
取值范围:
不涉及
- 响应样例
STATUS CODE 200
1 2 3
{ "job_id": "edc89b490d7d4392898e19b2deb34797" }
返回值
- 正常
- 异常
返回值
说明
400 Bad Request
请求错误,具体返回错误码请参见错误码。
401 Unauthorized
鉴权失败。
403 Forbidden
没有操作权限。
404 Not Found
找不到资源。
500 Internal Server Error
服务内部错误。
503 Service Unavailable
服务不可用。