接口功能介绍

使用存在对象存储的桶上的指定的镜像文件来创建 1 份云主机私有镜像
准备：
1. 在调用前需了解如何构造请求，可参见：如何调用 API - 构造请求
2. OpenAPI 请求需进行加密调用，可参见：如何调用 API - 认证鉴权
注意：
1. 在调用前，请您认真阅读此文档，包括但不限于参数描述中的“注意”部分
2. 此接口在多可用区资源池中可响应创建中的私有镜像的 imageID。此时，若您欲删除镜像状态为 error 的私有镜像，则可使用删除私有镜像接口来删除 1 份私有镜像
3. 此接口在非多可用区资源池中可响应创建中的私有镜像的 taskID。此时，若您欲删除镜像状态为 error 的私有镜像，则可使用删除创建私有镜像（镜像文件）任务接口来删除 1 个失败的使用镜像文件来创建私有镜像的任务

接口约束

接口请求成功需至少满足：
1. 您具有调用此接口的权限
2. 传入的有取值范围的参数的值在取值范围内且满足要求
3. 传入的 imageFileSource 参数所指定的镜像文件地址满足要求
4. 传入的 imageProperties.description 参数所指定的描述信息满足要求
5. 传入的 imageProperties.imageName 参数所指定的镜像名称满足要求
6. 传入的 imageProperties.imageType 参数所指定的镜像类型满足要求
7. 传入的 labels 参数所指定的标签列表满足要求
8. 传入的 projectID 参数所指定的企业项目对您而言是存在的
9. 传入的 regionID 参数所指定的资源池对您而言是存在的
10. 您的私有镜像配额余量足够，即可创建的私有镜像数量未达上限

URI

POST /v4/image/import

路径参数
无

Query参数
无

请求参数

请求头header参数
无

请求体body参数

表 imageProperties

表 labels

响应参数

表 returnObj

表 image

枚举参数

参数名 osDistro

参数名 imageIntegrityCheckStatus

参数名 rejected

参数名 imageVisibility

请求示例

请求url

无

请求头header

无

请求体body

示例 1：在华东 1 使用镜像文件来创建 1 份云主机私有系统盘镜像。
{
  "imageFileSource": "https://jiangsu-10.zos.ctyun.cn/ims-openapi/ImportSystemDiskImage.qcow2",
  "imageProperties": {
    "architecture": "aarch64",
    "diskSize": 40,
    "imageName": "CTyunOS-test",
    "maximumRAM": 2,
    "osDistro": "CTyunOS",
    "osVersion": "23.01"
  },
  "labels": [{ "labelKey": "test-key", "labelValue": "test-value" }],
  "regionID": "bb9fdb42056f11eda1610242ac110002"
}

示例 2：在华东 1 使用镜像文件来创建 1 份云主机私有数据盘镜像。
{
  "imageFileSource": "https://jiangsu-10.zos.ctyun.cn/ims-openapi/ImportDataDiskImage.qcow2",
  "imageProperties": {
    "diskSize": 10,
    "imageName": "CTyunOS-test",
    "imageType": "data_disk_image",
    "osDistro": "CTyunOS"
  },
  "labels": [{ "labelKey": "test-key", "labelValue": "test-value" }],
  "regionID": "bb9fdb42056f11eda1610242ac110002"
}

响应示例

{
  "returnObj": {
    "images": [
      {
        "appVersion": null,
        "architecture": "x86_64",
        "azName": null,
        "bootMode": "bios",
        "chargeableImage": false,
        "containerFormat": "bare",
        "createdTime": 1698145871,
        "createdTimeStr": "2023-10-24T11:11:11Z",
        "cwaiType": null,
        "description": "Test CTyunOS",
        "destinationAccountID": null,
        "destinationUser": null,
        "diskFormat": "raw",
        "diskID": null,
        "diskSize": 40,
        "enableImageIntegrityCheck": false,
        "fullECSDiskSize": null,
        "gpuImageCategory": null,
        "hasAcceptedSharedImages": false,
        "imageClass": "ECS",
        "imageDisplayName": null,
        "imageID": "8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa",
        "imageIntegrityCheckStatus": null,
        "imageName": "CTyunOS-test",
        "imageScene": null,
        "imageShareCount": 0,
        "imageSize": 42949672960,
        "imageSource": "image_file",
        "imageStatus": "queued",
        "imageSubcategory": null,
        "imageType": null,
        "imageVisibility": "private",
        "maximumRAM": 0,
        "minimumRAM": 0,
        "osDistro": "CTyunOS",
        "osType": "linux",
        "osVersion": "23.01",
        "projectID": "0",
        "sourceAccountID": null,
        "sourceServerID": null,
        "sourceUser": null,
        "supportOneClickSFSMount": false,
        "supportXSSD": false,
        "taskID": null,
        "updatedTime": 1698145871,
        "updatedTimeStr": "2023-10-24T11:11:11Z"
      }
    ]
  },
  "errorCode": "",
  "message": "SUCCESS",
  "description": "成功",
  "statusCode": 800
}

状态码

请参考 状态码

错误码

请参考 错误码