接口功能介绍

使用指定的云主机的系统盘（若是在创建时使用 ISO 镜像的云主机，则指其仅有的数据盘）来创建 1 份私有系统盘镜像。
准备：
1. 在调用前需了解如何构造请求，可参见：如何调用 API - 构造请求。
2. OpenAPI 请求需进行加密调用，可参见：如何调用 API - 认证鉴权。
注意：在调用前，请您认真阅读此文档，包括但不限于参数描述中的“注意”部分。

接口约束

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

URI

POST /v4/image/create

路径参数
无

Query参数
无

请求参数

请求头header参数
无

请求体body参数

表 labels

响应参数

表 returnObj

表 image

枚举参数

无

请求示例

请求url

无

请求头header

无

请求体body

示例：若您在华东 1 有 1 台 ID 为 88f888ea-88ff-88ec-a8bc-888888888fe8 的云主机，则可参考如下形式创建私有系统盘镜像。
{
  "description": "Test CTyunOS",
  "imageName": "CTyunOS-test",
  "instanceID": "88f888ea-88ff-88ec-a8bc-888888888fe8",
  "labels": [{ "labelKey": "test-key", "labelValue": "test-value" }],
  "maximumRAM": 2,
  "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": "8888a888-b888-8888-a888-baee8d8ce88c",
        "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": "cloud_server",
        "imageStatus": "queued",
        "imageSubcategory": null,
        "imageType": null,
        "imageVisibility": "private",
        "maximumRAM": 0,
        "minimumRAM": 0,
        "osDistro": "CTyunOS",
        "osType": "linux",
        "osVersion": "23.01",
        "projectID": "0",
        "sourceAccountID": null,
        "sourceServerID": "88f888ea-88ff-88ec-a8bc-888888888fe8",
        "sourceUser": null,
        "supportOneClickSFSMount": false,
        "supportXSSD": false,
        "taskID": null,
        "updatedTime": 1698145871,
        "updatedTimeStr": "2023-10-24T11:11:11Z"
      }
    ]
  },
  "errorCode": "",
  "message": "SUCCESS",
  "description": "成功",
  "statusCode": 800
}

状态码

请参考 状态码

错误码

请参考 错误码