接口功能介绍
导出 1 份云主机私有镜像到指定的对象存储的桶。
准备：
1. 在调用前需了解如何构造请求，可参见：如何调用 API - 构造请求。
2. OpenAPI 请求需进行加密调用，可参见：如何调用 API - 认证鉴权。
注意：
1. 在调用前，请您认真阅读此文档，包括但不限于参数描述中的“注意”部分。
2. 接口请求成功后，可使用查询桶内碎片列表接口来查询桶内所有分段上传的碎片，从而获知大致的导出进度。若涉及镜像文件格式转换（如镜像实际为 RAW 格式，导出时指定了 QCOW2 格式），则您需等待一段时间后才能查询到相应的桶内碎片，具体等待时间受镜像大小等因素影响。
接口约束
接口请求成功需至少满足：
1. 您具有调用此接口的权限。
2. 传入的有取值范围的参数的值在取值范围内且满足要求。
3. 传入的 bucket 参数所指定的桶满足要求。
4. 传入的 filename 参数所指定的导出文件名称满足要求。
5. 传入的 imageID 参数所指定的镜像满足要求。
6. 传入的 regionID 参数所指定的资源池对您而言是存在的。
URI
POST /v4/image/export
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| bucket | 是 | String | 存储桶名。可使用查询所有桶接口来查询您拥有的桶的列表，可使用查询桶信息接口来查询 1 个桶的详细信息。注意：所指定的桶应是属于您的、存储类型为 STANDARD 的桶。 | bucket-fa88 | |
| filename | 是 | String | 导出文件名称。注意：长度为 2~100 个字符，只能由数字、字母、- 组成，不能以数字、- 开头，且不能以 - 结尾。 | CTyunOS-test | |
| imageID | 是 | String | 镜像 ID。可使用查询可以使用的镜像资源接口来查询您可使用的镜像资源，可使用查询镜像详细信息接口来查询 1 份镜像的详细信息。注意： 1. 所指定的镜像应是镜像状态为 active、镜像类型为空（系统盘镜像）或 data_disk_image 的云主机私有镜像。 2. 仅在传入的 regionID 参数所指定的资源池具备导出系统盘镜像的功能时支持镜像类型为空（系统盘镜像）的云主机私有镜像。数据盘镜像同理。 3. 所指定的镜像在导出完成前一般不能再导出。 |
8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa | |
| regionID | 是 | String | 资源池 ID。可使用资源池列表查询接口来查询您可见的资源池的列表。 | 88f8888888dd88ec888888888d888d8b | |
| imageFileFormat | 否 | String | 镜像文件格式。取值范围（值：描述）： raw：RAW 格式（默认值）。 qcow2：QCOW2 格式。 vhd：VHD 格式。 vmdk：VMDK 格式。 注意：在此参数值为 vhd 或 vmdk 时，若传入的 regionID 参数所指定的资源池不具备导出成 VHD 或 VMDK 格式的镜像文件的功能，则此参数将使用默认值。 |
raw |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。取值范围（值：描述）： 800：成功。 900：失败。 |
800 | |
| error | String | 错误码（product.module.code 三段式码）。 | Openapi.PatternCheck.NotValid | |
| errorCode | String | 同 error 参数。 | Openapi.PatternCheck.NotValid | |
| message | String | 响应状态描述（一般为英文）。 | SUCCESS | |
| description | String | 响应状态描述（一般为中文）。 | 成功 | |
| returnObj | Object | 成功时返回的数据。 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例：若您在华东 1 有 1 个名为 bucket-fa88 的桶和 1 份 ID 为 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa 的云主机私有镜像，则可参考如下形式导出成 QCOW2 格式的镜像文件到指定的桶。
{
"bucket": "bucket-fa88",
"filename": "CTyunOS-test",
"imageFileFormat": "qcow2",
"imageID": "8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa",
"regionID": "bb9fdb42056f11eda1610242ac110002"
}
响应示例
{
"statusCode": 800,
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"returnObj": {}
}
状态码
请参考 状态码
错误码
请参考 错误码
