更新时间:2024-04-17 GMT+08:00

跨Region复制镜像

功能介绍

该接口为扩展接口,用户在一个区域制作的私有镜像,可以通过跨Region复制镜像将镜像复制到其他区域,在其他区域发放相同类型的云服务器,帮助用户实现区域间的业务迁移。

该接口为异步接口,返回job_id说明任务下发成功,查询异步任务状态,如果是success说明任务执行成功,如果是failed说明任务执行失败。

约束与限制

  • 跨区域复制镜像的目的区域不能与镜像源区域相同。
  • 加密镜像不支持跨区域复制。
  • 用于跨区域复制的镜像不能超过128GB。
  • 跨区域复制镜像单租户并发复制不能超过5个私有镜像。
  • 使用ISO文件创建的私有镜像不支持跨区域复制。

URI

POST /v1/cloudimages/{image_id}/cross_region_copy

参数说明请参见表1
表1 参数说明

参数

是否必选

参数类型

描述

image_id

String

镜像ID。

如何获取镜像ID,请参见查询镜像列表

请求消息

请求参数

参数

是否必选

参数类型

描述

name

String

镜像名称。name参数说明请参考镜像属性

description

String

镜像描述信息。description参数说明请参考镜像属性。支持字母、数字、中文等,不支持回车、<、>,长度不能超过1024个字符。默认为空。

region

String

目的区域的Region ID。

如何获取Region ID列表,请参见《统一身份认证服务接口参考》“查询区域列表”章节。

project_name

String

目的区域的项目名称。

agency_name

String

委托名称。

怎样创建IAM委托,请参见《镜像服务用户指南》“如何创建IAM委托”章节。

vault_id

String

存储库ID。

如果是整机镜像,则在跨Region复制镜像时,为必选参数,需传入该值。

存储库ID可以从云备份服务控制台获取,或者参考《云备份接口参考》的“查询存储库列表”章节查询。

请求示例

  • 跨Region复制镜像,其中,目的区域的Region ID为“region-1”、目的区域的项目名称为“project-1”。
    1
    2
    3
    4
    5
    6
    7
    8
    POST https://{Endpoint}/v1/cloudimages/465076de-dc36-4aec-80f5-ef9d8009428f/cross_region_copy
    {
        "name":"test-copy-1001-4",
        "description":"test",
        "region":"region-1",
        "project_name":"project-1",
        "agency_name":"ims_copy_image"
    }
    
  • 跨Region复制整机镜像,其中,目的区域的Region ID为“region-1”、目的区域的项目名称为“project-1”、存储库ID为“6yhtb5df-1bc3-4c3f-893e-3e4716yhgt61”。
    1
    2
    3
    4
    5
    6
    7
    8
    9
    POST https://{Endpoint}/v1/cloudimages/465076de-dc36-4aec-80f5-ef9d8009428f/cross_region_copy
    {
        "name":"test-copy-1001-4",
        "description":"test",
        "region":"region-1",
        "project_name":"project-1",
        "agency_name":"ims_copy_image",
        "vault_id":"6yhtb5df-1bc3-4c3f-893e-3e4716yhgt61"
    }
    

响应消息

  • 响应参数

    参数

    参数类型

    描述

    job_id

    String

    异步任务ID。

  • 响应样例
    STATUS CODE 200
    1
    2
    3
    {
        "job_id": "edc89b490d7d4392898e19b2deb34797"
    }
    

返回值

  • 正常

    200

  • 异常

    返回值

    说明

    400 Bad Request

    请求错误,具体返回错误码请参错误码

    401 Unauthorized

    鉴权失败。

    403 Forbidden

    没有操作权限。

    404 Not Found

    找不到资源。

    500 Internal Server Error

    服务内部错误。

    503 Service Unavailable

    服务不可用。