接口功能介绍
导出一份私有镜像到指定的对象存储(原生版)Ⅰ 型的桶。
接口约束
接口请求成功需至少满足:
1. 所指定的私有镜像的状态应是 active。可使用查询镜像详细信息接口来查询一份镜像的详细信息。
2. 所指定的对象存储的桶存在且读写权限为私有或公共读写。可使用查询桶访问权限接口来查询存储空间是否有权访问或是否存在。
注意:导出请求发出后,镜像文件真正完成导出到对象存储的桶中需等待一段时间,具体等待时间受文件大小等因素影响。
URI
POST /v4/image/export
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
bucket | 是 | String | 对象存储的桶。可使用查询所有桶接口来查询您拥有的桶的列表。 | bucket-fa88 | |
filename | 是 | String | 在对象存储的桶中的存储名称。注意:长度为 2~100 个字符,只能由数字、字母、- 组成,不能以数字、- 开头,且不能以 - 结尾。建议不要与已有文件名重复。若对象存储的桶未开启版本控制,则使用重复的文件名将覆盖原同名文件。 | CentOS-test | |
imageID | 是 | String | 镜像 ID。可使用查询可以使用的镜像资源接口来查询您可使用的镜像资源。 | 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa | |
regionID | 是 | String | 资源池 ID。可使用资源池列表查询接口来查询您可见的资源池的列表。 | 88f8888888dd88ec888888888d888d8b | |
imageFileFormat | 否 | String | 镜像文件格式,取值范围(值:描述): qcow2:QCOW2 格式 raw:RAW 格式(默认值) vhd:VHD 格式 vmdk:VMDK 格式 注意:仅在多可用区资源池下生效。可使用资源池概况信息查询接口来确认所指定的资源池是否是多可用区资源池。 |
raw |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码,取值范围(值:描述): 800:成功 900:失败 |
800 | |
error | String | 错误码(product.module.code 三段式码)。 | ||
errorCode | String | 同“error”参数。 | ||
message | String | 响应状态描述(一般为英文)。 | ||
description | String | 响应状态描述(一般为中文)。 | ||
returnObj | Object | 返回参数。 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"bucket": "bucket-fa88",
"filename": "CentOS-test",
"imageID": "8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa",
"regionID": "88f8888888dd88ec888888888d888d8b",
"imageFileFormat": "raw"
}
响应示例
{
"statusCode": 800,
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"returnObj": {}
}
状态码
请参考 状态码
错误码
请参考 错误码