云桌面 WORKSPACE-创建镜像实例:请求参数

时间:2024-09-05 16:31:22

请求参数

表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字符。

support.huaweicloud.com/api-workspace/CreateImageServer.html