文档首页/ 云桌面 Workspace/ API参考/ 云应用API/ 镜像管理/ 创建镜像实例
更新时间：2024-09-05 GMT+08:00
查看PDF
分享

创建镜像实例

功能介绍

创建镜像实例。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v1/{project_id}/image-servers

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目唯一标识。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

Service-Transaction-Id

否

String

CBC接口回调时，请求头里带上的业务ID。
表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

镜像实例名称，名称需满足如下规则:

  1. 由中文，英文大小写，数字，_-组成，不能有空格
  2. 长度范围1~64个字符

description

否

String

镜像实例描述

root_volume

是

Volume object

镜像实例系统盘配置信息

image_ref

是

ImageRef object

镜像源信息。

vpc_id

是

String

镜像实例所属虚拟私有云唯一标识。

subnet_id

是

String

镜像实例网卡对应的子网唯一标识

product_id

是

String

镜像实例产品套餐ID

flavor_id

否

String

规格ID。

availability_zone

否

String

镜像实例的可用区，空值表示随机选取可用区

attach_apps

否

Array of strings

云应用仓库软件唯一标识请求列表

authorize_accounts

是

Array of ImageAccountInfo objects

应用组授权用户，

  • 限制用户类型：'USER' - 用户

ou_name

否

String

组织名称

is_vdi

否

Boolean

是否为vdi单会话模式

scheduler_hints

否

WdhParam object

wdh参数

extra_session_type

否

String

付费会话类型

  • GPU - GPU规格会话
  • CPU - 普通CPU规格会话

extra_session_size

否

Integer

需要付费的会话数，单位/个

route_policy

否

RoutePolicy object

路由策略

tags

否

Array of TmsTag objects

标签信息，最多包含20个key,不允许重复

enterprise_project_id

否

String

⚠ : 此属性是预留字段，不需要传值，目前镜像产物默认属于default企业项目 镜像所属的企业项目ID，默认属于default企业项目。 关于企业项目ID的获取及企业项目特性的详细信息，请参考“企业中心总览”。
表4 Volume

参数

是否必选

参数类型

描述

type

是

String

磁盘类型，获取可用磁盘类型详见接口磁盘管理ListVolumeType。

  • ESSD - 极速型SSD
  • SSD - 超高IO
  • GPSSD - 通用型SSD
  • SAS - 高IO
  • SATA - 普通IO

size

是

Integer

磁盘容量，单位GB，数值约束为10的倍数。

  • 系统盘 minLength: 10，maxLength: 1024
  • 数据盘 minLength: 10，maxLength: 32768

cluster_id

否

String

云服务器系统盘对应的存储池的ID。
表5 ImageRef

参数

是否必选

参数类型

描述

id

是

String

镜像源的唯一标识。

image_type

是

String

镜像源的镜像类型:

  • gold - 云市场镜像
  • public - 公共镜像
  • private - 私有镜像
  • shared - 共享镜像
  • other - 其他

spce_code

否

String

镜像源的规格编码，对于gold镜像类型，这个值是的必须项。

product_id

否

String

镜像源的产品ID，对于gold镜像类型，这个值是的必须项。
表6 ImageAccountInfo

参数

是否必选

参数类型

描述

account

是

String

用户(组)。

account_type

是

String

用户类型：

  • USER - 用户
  • USER_GROUP - 用户组

domain

否

String

域名城。
表7 WdhParam

参数

是否必选

参数类型

描述

dedicated_host_id

否

String

云办公主机id

tenancy

否

String

类型
表8 RoutePolicy

参数

是否必选

参数类型

描述

max_session

否

Integer

单台服务器最大的链接会话数。

cpu_threshold

否

Integer

cpu使用率阈值，单位为%。

mem_threshold

否

Integer

内存使用率阈值，单位为%。
表9 TmsTag

参数

是否必选

参数类型

描述

key

是

String

键。最大长度128个unicode字符。

value

否

String

值。每个值最大长度255个unicode字符。

响应参数

状态码： 200

表10 响应Body参数

参数

参数类型

描述

job_id

String

任务ID。

状态码： 400

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 401

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 403

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 404

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 405

表15 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 409

表16 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 500

表17 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 503

表18 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

请求示例

POST /v1/a4da8115c9d8464ead3a38309130523f/image-servers

{
  "name" : "镜像任务0508",
  "description" : "测试镜像创建。",
  "availability_zone" : "",
  "image_ref" : {
    "id" : "da02e5ca-c6ec-4685-8ecb-f116bb5bdd2c",
    "image_type" : "gold",
    "spce_code" : "90a6e84bb3e822fe54999b6be5bbae1e",
    "product_id" : "OFFI874943784560095232"
  },
  "vpc_id" : "59785ba5-e5d5-4836-b9de-19f22ac15175",
  "subnet_id" : "a5842cb4-5718-4b0a-8b27-3a3e9c74f977",
  "product_id" : "workspace.x86.performance.xlarge4",
  "attach_apps" : [ ],
  "authorize_accounts" : [ {
    "account" : "administrator",
    "account_type" : "USER",
    "domain" : "wksapp**.huawei.com"
  } ],
  "ou_name" : null,
  "root_volume" : {
    "type" : "SATA",
    "size" : 60
  },
  "is_vdi" : true
}

响应示例

状态码： 200

成功响应。

{
  "job_id" : "697612196825268224"
}

状态码

状态码

描述

200

成功响应。

400

由于包含语法错误，当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

请求中指定的方法不被允许。

409

请求存在冲突无法处理该请求。

500

服务内部错误，具体返回错误码请参见错误码说明。

503

服务不可用。

错误码

请参见错误码。

父主题： 镜像管理

相关文档