# 创建镜像实例 - CreateImageServer #### 功能介绍 创建镜像实例。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/WorkspaceApp/doc?api=CreateImageServer)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | workspace:imageServer:create | Write | imageServer \* | - | - | - ims:images:list - vpc:ports:get - vpc:subnets:get | | workspace:imageServer:create | Write | - | g:EnterpriseProjectId | - | - ims:images:list - vpc:ports:get - vpc:subnets:get | #### 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。 | | X-Linked-Id | 否 | String | 交易组件调用时下发的关联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的获取及企业项目特性的详细信息，请参考"[企业中心总览](https://support.huaweicloud.com/zh-cn/usermanual-em/zh-cn_topic_0123692049.html)"。 | 表4Volume | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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。 | 表5ImageRef | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 是 | String | 镜像源的唯一标识。 | | image_type | 是 | String | 镜像源的镜像类型: - *gold* - 云市场镜像 - *public* - 公共镜像 - *private* - 私有镜像 - *shared* - 共享镜像 - *other* - 其他 | | spce_code | 否 | String | 镜像源的规格编码，对于*gold*镜像类型，这个值是的必须项。 | | product_id | 否 | String | 镜像源的产品ID，对于*gold*镜像类型，这个值是的必须项。 | 表6ImageAccountInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | account | 是 | String | 用户(组)。 | | account_type | 是 | String | 用户类型： - *USER* - 用户 - *USER_GROUP* - 用户组 | | domain | 否 | String | 域名称。 | 表7WdhParam | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | dedicated_host_id | 否 | String | 云办公主机id。 | | tenancy | 否 | String | 类型。 | 表8RoutePolicy | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | max_session | 否 | Integer | 单台服务器最大的连接会话数。 | | cpu_threshold | 否 | Integer | cpu使用率阈值，单位为%。 | | mem_threshold | 否 | Integer | 内存使用率阈值，单位为%。 | 表9TmsTag | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 是 | String | 键。最大长度128个unicode字符。 1. 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格，以及以下字符： _ . : = + - @ 2. 两头不能有空白字符 | | value | 否 | String | 值。每个值最大长度255个unicode字符。 1. 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格，以及以下字符： _ . : = + - @ | #### 响应参数 **状态码：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 | 服务不可用。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode_0.html)。