ExportImage - 导出镜像

导出指定密码机的镜像。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-hsm:ExportImage

none

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

密码机实例 ID。

hsm-cn-vj30bil8****

ImageId

string

镜像 ID。

image-8vbdd5uc6v10ecn5****

返回参数

名称

类型

描述

示例值

object

响应信息。

RequestId

string

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

4C467B38-3910-447D-87BC-AC049166F216

Job

object

返回的异步任务信息。

JobId

string

任务 ID。

b1748ca6-6b55-49f4-a6d4-2d694a9f3693

Type

string

任务操作类型。

  • create:创建任务

  • cancel:取消任务

create

Completed

boolean

任务是否完成。

  • true:已完成

  • false:未完成

true

Status

string

任务状态。

  • running:执行中

  • cancel:取消

  • fail:失败

  • success:成功

running

Response

string

操作成功后的响应信息。

success

Error

string

操作异常或者失败时的错误信息。

Job.Canceled

Process

integer

任务执行进度。单位为百分比。

100

示例

正常返回示例

JSON格式

{
  "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
  "Job": {
    "JobId": "b1748ca6-6b55-49f4-a6d4-2d694a9f3693",
    "Type": "create",
    "Completed": true,
    "Status": "running",
    "Response": "success",
    "Error": "Job.Canceled",
    "Process": 100
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidApiParam.Error api param is invalid
500 InternalError The request processing has failed due to some unknown error. 未知错误导致请求处理失败。
403 NoPermission User has no permission to access this resource.
403 Backup.ActionForbidden This API is forbidden for this backup type.

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情