You need to enable JavaScript to run this app.
导航
云服务器
  • 文档首页
    • /
  • 云服务器

ExportImage - 导出镜像

最近更新时间：2024.05.21 10:32:35

首次发布时间：2022.05.28 07:11:28

我的收藏

调用 ExportImage 接口，导出自定义镜像。

请求说明

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数
类型
是否必填
示例值
描述
Action
String
是

ExportImage

要执行的操作，取值：ExportImage。

Version
String
是

2020-04-01

API的版本，取值：2020-04-01。

ImageId
String
是

image-4431h3l7hl31a0******

镜像ID。您可以调用DescribeImages接口并传入Visibility=private参数，查询获取自定义镜像ID。

TOSBucket
String
是

bucket-1

导出镜像文件所在的TOS Bucket名称。您可以调用ListBuckets接口，查询获取TOS桶名称。

TOSPrefix
String
是

test123

自定义导出镜像文件的前缀名。

  • 由数字或字母组成
  • 字符长度为1~30
    最终保存到TOS的镜像文件名为：
    自定义前缀名_ImageId_system.qcow2

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数
类型
示例值
描述
TaskId
String

t-3teco18f1w5a71******

导出镜像的任务ID。

请求示例

GET /?Action=ExportImage&Version=2020-04-01&ImageId=image-4431h3l7hl31a0******&TOSBucket=bucket-1&TOSPrefix=test123 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: ecs

返回示例

{
    "ResponseMetadata":{
        "RequestId":"2021110417394001022514606307*****",
        "Action":"ExportImage",
        "Version":"2020-04-01",
        "Service":"ecs",
        "Region":"cn-beijing"
    },
    "Result": {
        "TaskId": "t-3teco18f1w5a71******"
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
InvalidImageForExportImage.UnSupported
The specified image cannot be used for ExportImage.

指定的镜像不支持导出。

400
InvalidImageStatus
The specified image is not in the correct status for the request.

当前镜像的状态不支持此操作。

400
InvalidTOSPrefix.Malformed
The specified TOSPrefix is malformed.

自定义的文件前缀名不合法。

400
InvalidTosPutObject.AccessDenied
The Action tos:PutObject is not authorized for ecs, please check your IAM policy of ecs.

tos:PutObject未授权给ecs，请检查您的ecs IAM策略。

400
MissingParameter.ImageId
The required parameter ImageId is not supplied.

镜像ID不能为空。

400
MissingParameter.TOSBucket
The required parameter TOSBucket is not supplied.

TOS Bucket不能为空。

400
MissingParameter.TOSPrefix
The required parameter TOSPrefix is not supplied.

导出镜像文件的前缀名不能为空。

404
InvalidImage.NotFound
The specified image does not exist.

指定的镜像不存在。

404
InvalidTOSBucket.NotFound
The specified TOSBucket does not exist.

指定的TOS Bucket不存在。

412
OperationDenied.ResourceLocked
The specified operation is denied as your resource is locked for another operation.

指定的操作被拒绝，因为您的资源已被其他操作锁定。

500
InternalError
An internal error has occurred.

内部错误，请重试。如果多次尝试失败，请提交工单。