文档首页/ 云桌面 Workspace/ API参考/ 云应用API/ 服务器管理/ 创建云服务器
更新时间：2025-11-05 GMT+08:00
查看PDF
分享

创建云服务器

功能介绍

创建云服务器接口。

调试

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

URI

POST /v1/{project_id}/app-servers/actions/create

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目唯一标识。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。

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

X-Linked-Id

否

String

交易组件调用时下发的关联ID。

Service-Transaction-Id

否

String

CBC接口回调时，请求头里带上的业务ID 包周期场景必填 按需场景无。
表3 请求Body参数

参数

是否必选

参数类型

描述

type

是

String

创建云服务类型，当前仅支持创建云应用：createApps。

server_group_id

是

String

服务器组唯一标识。

availability_zone

否

String

可用分区。

说明：

  • 将服务创建到指定的可用分区，如果不指定则使用系统随机的可用分区将服务创建到指定的可用分区。

  • 获取方式详见可用区管理ListAvailabilityZone："GET /v1/{project_id}/availability-zone"。获取方式详见可用区管理ListAvailabilityZone："GET /v1/{project_id}/availability-zone/summary"。

subscription_num

是

Integer

订购数量。

nics

否

Array of Nic objects

服务对应的网卡信息，当前未使用该字段。

ou_name

否

String

OU名称，在对接AD时使用，需提前在AD中创建OU。

product_id

是

String

产品ID。

说明：

  • 获取方式详见产品套餐管理ListProduct："GET /v1/{project_id}/product"。

flavor_id

否

String

规格ID。

os_type

否

String

操作系统类型，当前仅支持Windows。

root_volume

是

Volume object

系统盘： 磁盘容量，磁盘容量最大只支持1024G, 且为10的倍数。

scheduler_hints

否

WdhParam object

专属主机： 专属主机只支持按需模式，包周期模式不支持专属主机。

subnet_id

是

String

网卡对应的子网ID。

vpc_id

是

String

虚拟私有云ID。

update_access_agent

否

Boolean

是否自动升级hda版本。

create_server_extend_param

否

CreateServerExtendParam object

创建云服务器附加信息。
表4 Nic

参数

是否必选

参数类型

描述

ip_address

否

String

IP地址。

subnet_id

否

String

网卡对应的子网ID。
表5 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。
表6 WdhParam

参数

是否必选

参数类型

描述

dedicated_host_id

否

String

云办公主机id。

tenancy

否

String

专属主机类型，目前只支持dedicated。 - dedicated：专属型 - shared： 共享型。
表7 CreateServerExtendParam

参数

是否必选

参数类型

描述

charging_mode

否

String

计费模式，取值范围：

  • prePaid-预付费，即包年包月；

  • postPaid-后付费，即按需付费；

period_type

否

Integer

周期类型 2：包月；3：包年* chargingMode为prePaid时生效且为必选值。

period_num

否

Integer

订购周期数，chargingMode为prePaid时生效且为必选值，periodNum为正整数，取值范围：

说明：

  • periodType=2（周期类型为月）时，取值为[1，9]。

  • periodType=3（周期类型为年）时，取值为[1，3]。

is_auto_renew

否

Boolean

是否是自动续订，默认不填为false。

说明：

  • false 不自动续订。

  • true 自动续订。

is_auto_pay

否

Boolean

下单订购后，是否自动从客户的账户中支付，而不需要客户手动去进行支付。chargingMode为prePaid时生效，不传该字段时默认为客户手动支付。

说明：

  • true ：是（自动支付）。

  • false：否（需要客户手动支付）。

响应参数

状态码：200

表8 响应Body参数

参数

参数类型

描述

job_id

String

对于创建云应用服务器命令下发后会返回job_id，通过job_id可以查询任务的执行状态,按需购买返回该参数。对于创建云应用服务器命令下发后会返回job_id，通过job_id可以查询任务的执行状态。

order_id

String

订单号，创建包年包月的弹性云服务器时返回该参数。

状态码：400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：401

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：403

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：500

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

请求示例

POST /v1/a4da8115c9d8464ead3a38309130523f/app-servers/actions/create

{
  "availability_zone" : "cn-north-5a",
  "subnet_id" : "085ca7d8-4474-4c32-bff0-31254d98c4a9",
  "nics" : [ {
    "subnet_id" : "085ca7d8-4474-4c32-bff0-31254d98c4a9"
  } ],
  "product_id" : "workspace.appstream.general.xlarge.2",
  "flavor_id" : "c3.large.4",
  "os_type" : "Windows",
  "root_volume" : {
    "type" : "SAS",
    "size" : 80
  },
  "server_group_id" : "f309fa65-881a-4f49-8c06-31e20437ae20",
  "vpc_id" : "d987ecf7-c6a4-4753-8b66-135dcc3eed79",
  "ou_name" : "",
  "update_access_agent" : false,
  "type" : "createApps",
  "subscription_num" : 1,
  "create_server_extend_param" : {
    "charging_mode" : "prePaid",
    "period_type" : 3,
    "period_num" : 2,
    "is_auto_renew" : false,
    "is_auto_pay" : false
  }
}

响应示例

状态码：200

成功响应。

{
  "job_id" : "575768277444198400",
  "order_id" : "CS2310081912FP1MC"
}

状态码

状态码

描述

200

成功响应。

400

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

401

鉴权失败。

403

没有操作权限。

500

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

错误码

请参见错误码。

父主题： 服务器管理

相关文档