接口功能介绍
使用指定的存在对象存储（原生版）Ⅰ 型的镜像文件来创建一份私有镜像。
接口约束
接口请求成功需至少满足：
1. 可创建的私有镜像数量未达上限。
2. 所指定的镜像文件地址是指定的资源池的对象存储的桶的对象的 URL，所指向的对象：
- 未加密，未处于归档冻结状态，并且对您可读（可使用校验镜像文件地址接口来校验一个镜像文件地址）；
- 是 QCOW2、RAW、VHD、VMDK 格式的镜像文件。
3. 在镜像属性中所指定的镜像名称不能与以下名称重复：
- 已有的私有镜像的名称（可使用查询可以使用的镜像资源接口来查询您可使用的镜像资源）；
- 处于 pending 任务状态的创建私有镜像（镜像文件）任务的镜像名称（可使用查询创建私有镜像（镜像文件）任务列表接口来查询使用镜像文件来创建私有镜像的任务列表）。
4. 请尽量确保所传参数值与镜像文件实际情况相符，否则可能会影响创建云主机等功能。
URI
POST /v4/image/import
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| imageFileSource | 是 | String | 镜像文件地址，格式应为 {internetEndpoint}/{bucket}/{key}。可使用访问控制 endpoint 查询接口来查询外网访问 endpoint，可使用查询所有桶接口来查询您拥有的桶的列表，可使用查看对象列表接口来查询存储桶内所有对象。 | https://xxx.zos.ctyun.cn/bucket-xxx/image-xxx | |
| imageProperties | 是 | Object | 镜像属性。注意：对启动方式、最大和最小内存的指定仅在镜像属性中镜像种类的取值为空或空字符串（系统盘镜像）时生效。此外，当前对启动方式、最大和最小内存的指定在多可用区资源池下不生效。可使用资源池概况信息查询接口来确认所指定的资源池是否是多可用区资源池。 | imageProperties | |
| regionID | 是 | String | 资源池 ID。可使用资源池列表查询接口来查询您可见的资源池的列表。 | 88f8888888dd88ec888888888d888d8b | |
| projectID | 否 | String | 企业项目 ID，默认值 0。 | 0 |
表 imageProperties
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| imageName | 是 | String | 镜像名称。注意：长度为 2~32 个字符，只能由数字、字母、- 组成，不能以数字、- 开头，且不能以 - 结尾。 | CentOS-test | |
| osDistro | 是 | String | 操作系统的发行版名称。注意：对于 Windows 系操作系统，应确保参数值是 windows，否则视作 Linux 系操作系统；对于 Linux 系操作系统，参数值的取值应根据系统实际情况，建议参照 cloud-init 的配置文件（/etc/cloud/cloud.cfg）中 system_info.distro 的取值或以下取值： anolis centos ctyunos debian fedora kylin openEuler ubuntu UnionTech windows |
centos | |
| osVersion | 是 | String | 操作系统版本。注意：参数值的取值应根据系统实际情况，建议参考（以下列出 osDistro 所列取值对应的 osVersion 参考取值）： anolis: 7.9 centos: 7.8 ctyunos: 2.0.1 debian: 9.0.0 fedora: 36 kylin: V10_sp1 openEuler: 20.03 ubuntu: 18.04 UnionTech: V20_1050u1e windows: 2008 |
7.8 | |
| architecture | 否 | String | 镜像系统架构取值范围（值：描述）： aarch64：AArch64 架构，仅支持 UEFI 启动方式 x86_64：x86_64 架构，支持 BIOS 和 UEFI 启动方式 注意：所指定的镜像系统架构应受所指定的资源池支持。 |
x86_64 | |
| bootMode | 否 | String | 启动方式，取值范围（值：描述）： bios：BIOS 启动方式 uefi：UEFI 启动方式 注意：若镜像系统架构为 aarch64，则对启动方式的指定不生效。此参数无默认值，不指定则表示使用镜像系统架构的默认启动方式（x86_64 架构的默认启动方式为 BIOS）。 |
bios | |
| description | 否 | String | 镜像描述信息。注意：长度为 1~128 个字符。 | Test CentOS | |
| diskSize | 否 | Integer | 磁盘容量，单位为 GB，取值范围：最小 5（默认值），最大 1024。注意：磁盘容量不能小于镜像文件的大小；若小于镜像文件的大小，则实际的磁盘容量将使用镜像文件的大小。 | 5 | |
| imageType | 否 | String | 镜像种类，取值范围（值：描述）： （空或空字符串）：系统盘镜像 data_disk_image：数据盘镜像 |
||
| maximumRAM | 否 | Integer | 最大内存，单位为 GB，取值范围：0（默认值，即不限制）/ 1 / 2 / 4 / 8 / 16 / 32 / 64 / 128 / 256 / 512。注意：若取值不为 0 且所指定的最小内存也不为不限制时，则取值应大于或等于所指定的最小内存。 | 0 | |
| minimumRAM | 否 | Integer | 最小内存，单位为 GB，取值范围：0（默认值，即不限制）/ 1 / 2 / 4 / 8 / 16 / 32 / 64 / 128 / 256 / 512。注意：若取值不为 0 且所指定的最大内存也不为不限制时，则取值应小于或等于所指定的最大内存。 | 0 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码，取值范围（值：描述）： 800：成功 900：失败 |
800 | |
| errorCode | String | 错误码（product.module.code 三段式码）。 | ||
| message | String | 响应状态描述（一般为英文）。 | ||
| description | String | 响应状态描述（一般为中文）。 | ||
| returnObj | Object | 返回参数。 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"imageFileSource": "https://xxx.zos.ctyun.cn/bucket-xxx/image-xxx",
"imageProperties": {
"imageName": "CentOS-test",
"osDistro": "centos",
"osVersion": "7.8",
"architecture": "x86_64",
"bootMode": "bios",
"description": "Test CentOS",
"diskSize": 40,
"imageType": "",
"maximumRAM": 0,
"minimumRAM": 0
},
"regionID": "88f8888888dd88ec888888888d888d8b",
"projectID": "0"
}
响应示例
{
"statusCode": 800,
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"returnObj": {}
}
状态码
请参考 状态码
错误码
请参考 错误码
