更新时间:2024-08-09 GMT+08:00

购买云手机服务器

功能介绍

购买云手机服务器,支持您复用已有的VPC网络管理云手机服务器,支持云手机服务器复用您已购买的共享带宽等资源。

  • 请确保您已具有虚拟私有云资源,创建服务器需要指定一个已有的虚拟私有云,否则无法创建服务器。同时请确保您的账号至少具有VPC ReadOnlyAccess权限,以便虚拟私有云资源可以被选取到。

  • 请确保您的账号已成功创建密钥对,并具有查询密钥对列表的细粒度权限ecs:serverKeypairs:list。若需要创建密钥对,请确保账号具有创建密钥对的细粒度权限ecs:serverKeypairs:create。

  • 请确保已正确创建委托(委托名称cph_admin_trust,委托服务CPH),委托未被删除, 确保委托包含VPC FullAccess权限,委托及权限校验失败将导致云手机服务器创建失败。创建委托时委托类型选择“云服务”,云服务选择“CPH”,即允许CPH调用云服务。

  • 请确保您使用的账号具有Security Administrator权限。

  • 请确保您有足够的服务器及网络配额,配额校验不通过将导致创建失败。

URI

POST /v2/{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

云手机服务器规格,不超过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。

表4 Port

参数

是否必选

参数类型

描述

name

String

应用端口名称,不超过16个字节,系统关键服务名称不能使用"adb"和"vnc"。

listen_port

Integer

端口号,大于等于10000,小于等于50000。

internet_accessible

String

为"true"则映射出公网访问(忽略大小写)。 为其他则不映射。

表5 extend_param

参数

是否必选

参数类型

描述

charging_mode

Integer

计费类型。

  • 0:包周期

period_type

Integer

订购周期类型。

  • 2:月

  • 3:年

period_num

Integer

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

is_auto_pay

Integer

是否自动付款。默认不自动付款。

  • 1:自动付款

  • 0:不自动付款

is_auto_renew

Integer

是否自动续订。默认不自动续订。

  • 1:自动续订

  • 0:不自动续订

enterprise_project_id

String

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

表6 Nic

参数

是否必选

参数类型

描述

subnet_id

String

租户自定义的子网 ID,为待创建的云服务器所属的子网。

需要指定tenant_vpc_id对应VPC下已创建的子网(subnet)的网络ID,UUID格式。

ipv6_enable

Boolean

是否支持ipv6。

取值为true时,标识此网卡支持ipv6。

ipv6_bandwidth

ipv6_bandwidth object

绑定的共享带宽信息,详情请参见 ipv6_bandwidth数据结构说明。

表7 ipv6_bandwidth

参数

是否必选

参数类型

描述

band_width_id

String

ipv6绑定的共享带宽ID。

表8 public_ip

参数

是否必选

参数类型

描述

ids

Array of strings

指定已有的EIP进行服务器创建,当前只支持传入一个已有的EIP ID。

eip

eip object

配置服务器自动分配弹性IP时,创建弹性IP的配置参数,详情见 eip 结构体。

count

Integer

Eip数量。默认为1,不需要Eip可设置为0,取值范围为0到手机IP数。

表9 eip

参数

是否必选

参数类型

描述

type

String

弹性公网IP的类型。

  • 5_telcom:电信

  • 5_union:联通

  • 5_bgp:全动态BGP

  • 5_sbgp:静态BGP

表10 phone_data_volume

参数

是否必选

参数类型

描述

volume_type

String

磁盘类型,只支持如下类型:

  • SSD

  • GPSSD

size

Integer

手机磁盘大小,单位GiB,取值范围[10,32768]。

表11 server_share_data_volume

参数

是否必选

参数类型

描述

volume_type

String

磁盘类型,只支持如下类型:

  • SSD

  • GPSSD

size

Integer

共享磁盘大小,单位GiB,取值范围[10,32768]。

表12 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,共享带宽

响应参数

状态码: 200

表13 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

order_id

String

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

product_id

String

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

server_ids

Array of strings

服务器ID列表。

请求示例

购买云手机服务器

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

错误码

请参见错误码