# 跨Region复制镜像 - CopyImageCrossRegion
#### 功能介绍
该接口为扩展接口，用户在一个区域制作的私有镜像，可以通过跨Region复制镜像将镜像复制到其他区域，在其他区域发放相同类型的云服务器，帮助用户实现区域间的业务迁移。
该接口为异步接口，返回job_id说明任务下发成功，查询异步任务状态，如果是success说明任务执行成功，如果是failed说明任务执行失败。
#### 约束与限制
- 跨区域复制镜像的目的区域不能与镜像源区域相同。
- 加密镜像不支持跨区域复制。
- 跨区域复制镜像的大小限制如下： "华南-广州"、"华东-上海一"、"华东-上海二"和"华北-北京四"用于跨区域复制的镜像不能超过300GiB；其他区域用于跨区域复制的镜像不能超过128GiB。
  
- 跨区域复制镜像单租户并发复制不能超过5个私有镜像。
- 使用ISO文件创建的私有镜像不支持跨区域复制。
 
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?locale=zh-cn&consoleCurrentProductId=ims&consoleCurrentProductshort=&product=IMS&api=CopyImageCrossRegion)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ims/ims_03_appendix_03.html)。
#### URI
POST /v1/cloudimages/{image_id}/cross_region_copy
参数说明请参见[表1]。
 表1参数说明 
| 参数       | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                      |
|:---|:---|:---|:---|
| image_id | 是    | String | **参数解释：** 镜像ID。如何获取镜像ID，请参见[查询镜像列表 - ListImages](https://support.huaweicloud.com/api-ims/ims_03_0602.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
   
#### 请求消息
请求参数
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|:---|:---|:---|:---|
| name         | 是    | String | **参数解释：** 镜像名称。name参数说明请参考[镜像属性](https://support.huaweicloud.com/api-ims/ims_03_0901.html#ims_03_0901__section61598810155254)。 **约束限制：** 名称的首尾字符不能为空格。 **取值范围：** 只能由中文、字母、数字、空格和特殊字符 - _ . 组成，且首尾字符都不能为空格。名称的长度为1～128位。 **默认取值：** 不涉及 |
| description  | 否    | String | **参数解释：** 镜像描述信息。description参数说明请参考[镜像属性](https://support.huaweicloud.com/api-ims/ims_03_0901.html#ims_03_0901__section61598810155254)。 **约束限制：** 不涉及。 **取值范围：** 支持字母、数字、中文等，不支持回车、\<、\>，长度不能超过1024个字符。 **默认取值：** 不涉及                     |
| region       | 是    | String | **参数解释：** 目的区域的Region ID。 如何获取Region ID列表，请参见"[查询区域列表](https://support.huaweicloud.com/api-iam/iam_05_0001.html)"。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                                                 |
| project_name | 是    | String | **参数解释：** 目的区域的项目名称。如何获取项目名称可参考[获取账号、IAM用户、项目的名称和ID](https://support.huaweicloud.com/api-iam/iam_17_0002.html#section0)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                                                                        |
| agency_name  | 是    | String | **参数解释：** 委托名称。 怎样创建IAM委托，请参见"[如何创建IAM委托？](https://support.huaweicloud.com/ims_faq/ims_faq_0042.html)"。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                                                              |
| vault_id     | 否    | String | **参数解释：** 存储库ID。 存储库ID可以从云备份服务控制台获取，或者参考"[查询存储库列表](https://support.huaweicloud.com/api-cbr/ListVault.html)"查询。 **约束限制：** 如果是整机镜像，则在跨Region复制镜像时，为必选参数，需传入该值。 **取值范围：** 不涉及 **默认取值：** 不涉及                      |
   
#### 请求示例
- 跨Region复制镜像，其中，目的区域的Region ID为"region-1"、目的区域的项目名称为"project-1"。
  ```
  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"。
  ```
  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。 详情请参见[6.6.2-异步任务进度查询 - ShowJobProgress](https://support.huaweicloud.com/api-ims/ims_03_0911.html)。 **取值范围：** 不涉及 |
     
  
- 响应样例
  ```
  STATUS CODE 200
  ```
  ```
  {
      "job_id": "edc89b490d7d4392898e19b2deb34797"
  }
  ```
  
 
#### 返回值
- 正常 200
  
- 异常
  
  | 返回值                       | 说明                                                                              |
  |:---|:---|
  | 400 Bad Request           | 请求错误，具体返回错误码请参见[错误码](https://support.huaweicloud.com/api-ims/ims_03_0908.html)。 |
  | 401 Unauthorized          | 鉴权失败。                                                                           |
  | 403 Forbidden             | 没有操作权限。                                                                         |
  | 404 Not Found             | 找不到资源。                                                                          |
  | 500 Internal Server Error | 服务内部错误。                                                                         |
  | 503 Service Unavailable   | 服务不可用。                                                                          |