更新时间:2025-03-06 GMT+08:00
分享

创建云手机裸服务器

功能介绍

该接口创建的服务器仅包含服务器和服务器的镜像,不包含云手机实例和镜像等内容。若需要创建包含云手机实例的服务器,请使用创建云手机服务器接口。

调试

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

URI

POST /v2.1/{project_id}/cloud-phone/servers

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目id。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

表3 请求Body参数

参数

是否必选

参数类型

描述

server_name

String

云手机裸服务器名称,不超过60个字符,只支持英文字母、数字、汉字、下划线和中划线。批量购买会在云手机裸服务器名称后自动添加序号,比如设置此参数为server-1,那么创建的云手机裸服务器名称会自动按序增加数字后缀,比如为server-1-0001。

server_model_name

String

云手机裸服务器规格名称。

count

Integer

购买的云手机裸服务器个数,最多可购买10台。

order_param

order_param object

订单结构体。

nics

Array of NicForSingleServer objects

租户自定义的网卡的结构体,为待创建的云手机裸服务器的网卡信息。

public_ip

public_ip object

租户自定义的弹性公网IP结构体。 配置云手机裸服务器的弹性IP信息的方式, 自动分配,需要指定新创建弹性IP的信息; 使用已有,需要指定已经购买的EIP ID。

availability_zone

String

待创建云手机裸服务器所在的可用区(AZ)的名称。如上海一可用区1为cn-east-3a。

data_volume

data_volume object

数据盘结构体。

keypair_name

String

指定登录云手机裸服务器已有密钥的名称。

enterprise_project_id

String

企业项目ID。 该字段不传(或传为字符串“0”),则将资源绑定给默认企业项目。

image_id

String

云手机裸服务器镜像ID,不超过36个字节。未指定时使用默认云手机裸服务器镜像。

表4 order_param

参数

是否必选

参数类型

描述

charging_mode

Integer

计费类型。 0:包周期

period_type

Integer

订购周期类型。 2:月 3:年

period_num

Integer

订购周期数。 当订购周期为月时,取值范围[1, 9]。 当订购周期为年时,取值范围[1,10]。

is_auto_pay

Integer

是否自动付款。默认不自动付款。 0:不自动付款 1:自动付款

is_auto_renew

Integer

是否自动续订。默认不自动续订。 0:不自动续订 1:自动续订

表5 NicForSingleServer

参数

是否必选

参数类型

描述

subnet_id

String

租户自定义的子网 ID,为待创建的云手机裸服务器所属的子网。 需要指定vpc_id对应VPC下已创建的子网(subnet)的网络ID,UUID格式

ipv6_enable

Boolean

是否支持ipv6,默认不支持ipv6。 false:不支持ipv6 true:支持ipv6

ipv6_band_width_id

String

ipv6绑定的共享带宽ID。

表6 public_ip

参数

是否必选

参数类型

描述

ids

Array of strings

指定已有的EIP进行云手机裸服务器创建,当前只支持传入一个已有的EIP ID。指定EIP后public_ip结构体中count字段和type字段不生效。

type

String

弹性公网IP的类型。 例如: 5_telcom:电信 5_union:联通 5_bgp:全动态BGP 5_sbgp:静态BGP

count

Integer

Eip数量。默认为0。取值范围为【0,1】

band_width

band_width object

云手机裸服务器使用的带宽信息。

表7 band_width

参数

是否必选

参数类型

描述

band_width_id

String

云手机服务器的带宽唯一标识,选共享带宽时必选。

band_width_size

Integer

云手机服务器的带宽大小,选独享带宽时必选。

band_width_charge_mode

Integer

云手机服务器带宽的计费方式。 0:bandwidth, 按带宽计费 1:traffic, 按流量计费

band_width_share_type

Integer

云手机服务器的带宽类型。 0:per,独享带宽 1:whole,共享带宽

表8 data_volume

参数

是否必选

参数类型

描述

volume_type

String

数据盘类型,只支持如下类型: SSD GPSSD

size

Integer

数据盘大小,单位GiB,取值范围[1,32768]

count

Integer

数据盘数量,默认值为1

响应参数

状态码:200

表9 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

order_id

String

订单ID,不超过64个字节。

product_id

String

产品ID,不超过64个字节。

server_ids

Array of strings

服务器ID列表。

error_msg

String

任务错误码说明。

error_code

String

任务错误码。

请求示例

创建云手机裸服务器请求体

POST https://{CPH Endpoint}/v2.1/{project_id}/cloud-phone/servers

{
  "server_name" : "cph-test-wy",
  "server_model_name" : "physical.rx2.32xlarge.4",
  "count" : 1,
  "order_param" : {
    "charging_mode" : 0,
    "period_type" : 2,
    "period_num" : 1,
    "is_auto_renew" : 0,
    "is_auto_pay" : 1
  },
  "nics" : [ {
    "subnet_id" : "3c5e2638-b71f-4499-8d1e-355e89f21ae0",
    "vpc_id" : "6eb5019f-df01-4ded-9486-d54e7b282ced",
    "ipv6_enable" : true,
    "ipv6_band_width_id" : "fbe74c2f-e2ba-427a-b8aa-1c7c4f510ac1"
  } ],
  "public_ip" : {
    "type" : "5_bgp",
    "count" : 1,
    "band_width" : {
      "band_width_share_type" : 0,
      "band_width_size" : 300,
      "band_width_charge_mode" : 1
    }
  },
  "keypair_name" : "KeyPair-1d1d-wy",
  "enterprise_project_id" : "0"
}

响应示例

状态码:200

OK

{
  "request_id" : "1564567b8bab40f34711234cb80d8574",
  "order_id" : "CS1710111105S8IPB",
  "product_id" : "00301-25217-0--0",
  "server_ids" : [ "1234567b8bab40ffb711234cb80d0234", "1678567b8bab40f93711234cb80d0764" ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档