购买云手机服务器
功能介绍
购买云手机服务器，支持您复用已有的VPC网络管理云手机服务器，支持云手机服务器复用您已购买的共享带宽等资源。
-
请确保您使用的账号具有CPH AgencyDependencyAccess权限。
-
请确保您有足够的服务器及网络配额，配额校验不通过将导致创建失败。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v2/{project_id}/cloud-phone/servers
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目id。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
server_name |
是 |
String |
云手机服务器名称，不超过60个字符，只支持英文字母、数字、汉字、下划线和中划线。批量购买会在服务器名称后自动添加序号，比如设置此参数为server-1，那么创建的云手机服务器名称会自动按序增加数字后缀，比如为server-1-0001。 |
|
server_model_name |
是 |
String |
云手机服务器规格，不超过64个字节。 |
|
phone_model_name |
是 |
String |
云手机规格，不超过64个字节。 |
|
image_id |
是 |
String |
云手机镜像ID，不超过32个字节。 |
|
count |
是 |
Integer |
购买的云手机服务器个数，最多可购买10台。 |
|
keypair_name |
否 |
String |
密钥对名称，不超过64个字节，用于云手机ADB登录。 |
|
ports |
否 |
Array of Port objects |
云手机启用的应用端口，云手机服务会做端口转发。 |
|
extend_param |
是 |
extend_param object |
计费模式参数。 |
|
tenant_vpc_id |
是 |
String |
租户自定义的VPC ID，为待创建的云服务器所属的虚拟私有云（简称VPC），需要指定已创建VPC的ID，UUID格式。 |
|
nics |
是 |
Array of Nic objects |
租户自定义的网卡的结构体，为待创建的云服务器的网卡信息。 |
|
public_ip |
是 |
public_ip object |
租户自定义的弹性公网IP结构体。 配置云服务器的弹性IP信息的方式， 自动分配，需要指定新创建弹性IP的信息； 使用已有，需要指定已经购买的EIP ID。 |
|
phone_count_per_ip |
否 |
Integer |
多少个手机共用一个vip。默认为手机开数，表示所有手机共享1个vip。取值范围：1到手机规格开数。 |
|
phone_data_volume |
否 |
phone_data_volume object |
手机磁盘结构体，2.0规格必选。 |
|
server_share_data_volume |
否 |
server_share_data_volume object |
共享存储磁盘结构体，2.0规格可选。 |
|
band_width |
是 |
band_width object |
云手机使用的带宽信息。 |
|
availability_zone |
否 |
String |
待创建云服务器所在的可用区，需要指定可用区（AZ）的名称。如上海一可用区1为cn-east-3a。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
应用端口名称，不超过16个字节，系统关键服务名称不能使用"adb"和"vnc"。 |
|
listen_port |
是 |
Integer |
端口号，大于等于10000，小于等于50000。 |
|
internet_accessible |
是 |
String |
为"true"则映射出公网访问（忽略大小写）。 为其他则不映射。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
charging_mode |
是 |
Integer |
计费类型。
|
|
period_type |
是 |
Integer |
订购周期类型。
|
|
period_num |
是 |
Integer |
订购周期数。 当订购周期为月时，取值范围[1, 9]。 当订购周期为年时，取值范围[1,10]。 |
|
is_auto_pay |
否 |
Integer |
是否自动付款。默认不自动付款。
|
|
is_auto_renew |
否 |
Integer |
是否自动续订。默认不自动续订。
|
|
enterprise_project_id |
否 |
String |
企业项目ID。 该字段不传（或传为字符串“0”），则将资源绑定给默认企业项目。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
subnet_id |
是 |
String |
租户自定义的子网 ID，为待创建的云服务器所属的子网。 需要指定tenant_vpc_id对应VPC下已创建的子网（subnet）的网络ID，UUID格式。 |
|
ipv6_enable |
否 |
Boolean |
是否支持ipv6。 取值为true时，标识此网卡支持ipv6。 |
|
ipv6_bandwidth |
否 |
ipv6_bandwidth object |
绑定的共享带宽信息，详情请参见 ipv6_bandwidth数据结构说明。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
ids |
否 |
Array of strings |
指定已有的EIP进行服务器创建，当前只支持传入一个已有的EIP ID。 |
|
eip |
否 |
eip object |
配置服务器自动分配弹性IP时，创建弹性IP的配置参数，详情见 eip 结构体。 |
|
count |
否 |
Integer |
Eip数量。默认为1，不需要Eip可设置为0，取值范围为0到手机IP数。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
volume_type |
是 |
String |
磁盘类型，只支持如下类型：
|
|
size |
是 |
Integer |
手机磁盘大小，单位GiB，取值范围[10，32768]。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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/{project_id}/cloud-phone/servers
{
"server_name" : "cph-kertus-1110",
"server_model_name" : "physical.kg1.4xlarge.cp",
"phone_model_name" : "kg1.cp.c20.d64SSD.e1v1",
"image_id" : "20060220200717f201120a2300000e91",
"count" : 1,
"keypair_name" : "keypair",
"ports" : [ {
"name" : "myServer1",
"listen_port" : 20000,
"internet_accessible" : "false"
}, {
"name" : "myServer2",
"listen_port" : 20001,
"internet_accessible" : "true"
} ],
"extend_param" : {
"charging_mode" : 0,
"period_type" : 2,
"period_num" : 1,
"is_auto_pay" : 0
},
"tenant_vpc_id" : "fca063f6-b942-42a8-9004-e5545f58d6a2",
"nics" : [ {
"subnet_id" : "f1cbfc37-eb42-4357-a0ec-9e4f11950908"
} ],
"public_ip" : {
"eip" : {
"type" : "5_bgp"
}
},
"band_width" : {
"band_width_share_type" : 0,
"band_width_size" : 300,
"band_width_charge_mode" : 1
}
}
响应示例
状态码： 200
OK
{
"request_id" : "1564567b8bab40f34711234cb80d8574",
"order_id" : "CS1710111105S8IPB",
"product_id" : "00301-25217-0--0",
"server_ids" : [ "1234567b8bab40ffb711234cb80d0234", "1678567b8bab40f93711234cb80d0764" ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。
