接口功能介绍
将 1 份云主机私有镜像从其所在的源资源池复制到目标资源池。
准备：
1. 在调用前需了解如何构造请求，可参见：如何调用 API - 构造请求。
2. OpenAPI 请求需进行加密调用，可参见：如何调用 API - 认证鉴权。
注意：在调用前，请您认真阅读此文档，包括但不限于参数描述中的“注意”部分。
接口约束
接口请求成功需至少满足：
1. 您具有调用此接口的权限。
2. 传入的 description 参数所指定的描述信息满足要求。
3. 传入的 destinationRegionID 参数所指定的目标资源池满足要求。
4. 传入的 imageID 参数所指定的源镜像 ID 满足要求。
5. 传入的 imageName 参数所指定的镜像名称满足要求。
6. 传入的 labels 参数所指定的标签列表满足要求。
7. 传入的 projectID 参数所指定的企业项目对您而言是存在的。
8. 传入的 regionID 参数所指定的源资源池满足要求。
9. 您在目标资源池的私有镜像配额余量足够，即在目标资源池可创建的私有镜像数量未达上限。
URI
POST /v4/image/cross-region-copy
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| destinationRegionID | 是 | String | 目标资源池 ID。注意：应是传入的 regionID 参数所指定的源资源池的私有镜像支持复制到的目标资源池。可使用查询私有镜像支持复制到的目标资源池接口来查询满足要求的目标资源池。 | bb8fdb88888f88eda8888888ac888888 | |
| imageID | 是 | String | 源镜像 ID。可使用查询可以使用的镜像资源接口来查询您可使用的镜像资源，可使用查询镜像详细信息接口来查询 1 份镜像的详细信息。注意： 1. 所指定的镜像应是磁盘容量不大于您所能跨域复制的 1 份私有镜像的最大大小、镜像类型不为 full_ecs_image 且镜像状态为 active 的云主机私有镜像。 2. 同 1 份源镜像在传入的 destinationRegionID 参数所指定的目标资源池中仅能有 1 份创建中的目标镜像。 |
8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa | |
| imageName | 是 | String | 目标镜像名称。注意： 1. 长度为 2~32 个字符，只能由数字、字母、- 组成，不能以数字、- 开头，且不能以 - 结尾。 2. 不能与您在传入的 destinationRegionID 参数所指定的目标资源池中已有的私有镜像的名称重复。可使用查询可以使用的镜像资源接口来查询您在目标资源池已有的私有镜像。 |
CTyunOS-test | |
| regionID | 是 | String | 源资源池 ID。可使用资源池列表查询接口来查询您可见的资源池的列表。注意：此接口仅支持具备镜像跨域复制功能的多可用区资源池。 | 88f8888888dd88ec888888888d888d8b | |
| description | 否 | String | 目标镜像描述信息。注意：长度为 1~128 个字符，不能以空格开头或结尾。 | Test CTyunOS | |
| labels | 否 | Array of Objects | 目标镜像标签列表。注意： 1. 列表中最多 10 个标签。 2. 标签键不可重复。 3. 单个标签键或值应满足长度为 1~32 个字符，不能换行，且不能以空格开头或结尾。 |
labels | |
| projectID | 否 | String | 目标镜像企业项目 ID。默认 0（即 default 企业项目）。可使用查询企业项目列表接口来查询您可以使用的企业项目 ID。 | 0 |
表 labels
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| labelKey | 是 | String | 标签键。 | test-key | |
| labelValue | 是 | String | 标签值。 | test-value |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。取值范围（值：描述）： 800：成功。 900：失败。 |
800 | |
| error | String | 错误码（product.module.code 三段式码）。 | Openapi.PatternCheck.NotValid | |
| errorCode | String | 同 error 参数。 | Openapi.PatternCheck.NotValid | |
| message | String | 响应状态描述（一般为英文）。 | SUCCESS | |
| description | String | 响应状态描述（一般为中文）。 | 成功 | |
| returnObj | Object | 成功时返回的数据。 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例：若您在华东 1 有 1 份 ID 为 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa 的云主机私有镜像，则可参考如下形式将此镜像复制到西南 1。
{
"description": "Test CTyunOS",
"destinationRegionID": "200000002368",
"imageID": "8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa",
"imageName": "CTyunOS-test",
"labels": [{ "labelKey": "test-key", "labelValue": "test-value" }],
"regionID": "bb9fdb42056f11eda1610242ac110002"
}
响应示例
{
"statusCode": 800,
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"returnObj": {}
}
状态码
请参考 状态码
错误码
请参考 错误码
