功能介绍

• 接口名称

  CreateCloudPhoneServer

• 功能描述

  购买系统定义网络的云手机服务器。

  

  云手机网络配置分为两种模式：

  • 自定义网络：自定义网络是云手机全新一代网络配置管理模式，支持您复用已有的VPC网络管理云手机服务器，支持云手机服务器复用您已购买的共享带宽等资源，自定义网络当前仅支持“西南-贵阳一”区域。
  • 系统定义网络：系统定义网络是云手机第一代网络模式，由系统为您的云手机服务器自动创建VPC网络及带宽，不支持复用您已有的VPC网络及带宽资源。

URI

POST /v1/{project_id}/cloud-phone/phones

请求消息

• 请求参数

  参数	是否必选	参数类型	描述
  server_name	是	String	云手机服务器名称 不超过60个字符，只支持英文字母、数字、汉字、下划线和中划线。 批量购买会在服务器名称后自动添加序号，比如设置此参数为server-1，那么创建的云手机服务器名称会自动按序增加数字后缀，比如为server-1-0001。
  server_model_name	是	String	云手机服务器规格，不超过64个字节。 可通过查询云手机服务器规格列表查询支持的云手机服务器规格，已下线的规格不可用来购买云手机服务器。
  phone_model_name	是	String	云手机规格，不超过64个字节。 可通过查询云手机规格列表查询支持的云手机规格。
  image_id	是	String	云手机镜像ID，不超过32个字节。 可通过查询手机镜像查询云手机规格对应的镜像ID。
  count	是	Integer	购买的云手机服务器个数，最多可购买10台。
  band_width	是	band_width结构体	云手机使用的带宽信息。独占带宽按流量计费，共享带宽可选择带宽大小。
  extend_param	是	extend_param结构体	计费模式参数。
  keypair_name	否	String	密钥对名称，不超过64个字节，用于云手机ADB登录。 获取密钥对的方式如下： 登录管理控制台，在服务列表，选择“计算 > 弹性云服务器”。 在左侧导航栏选择“密钥对”。
  vnc_enable	否	String	(已废弃)是否开启VNC方式登录云手机。 为"true"时开启（忽略大小写）。 为其他，则不开启。
  ports	否	port结构体数组	云手机启用的应用端口，云手机服务会做端口转发。
  subnet_cidr	否	String	服务器的子网信息，第一次购买系统会自动创建172.31.0.0/16的子网。需要自定义子网的客户，需要全部通过API购买，设置的子网，必须是子网的格式且和已有子网不能重叠。

  

  原vnc_enable字段废弃，云手机服务器均默认支持VNC功能。

  表2 band_width数据结构说明

  参数	是否必选	参数类型	描述
  band_width_id	否	String	共享带宽ID，优先用该参数为云手机绑定带宽。 可通过查询带宽信息获取带宽ID。
  band_width_share_type	否 band_width_id不存在时必选	Integer	带宽类型 0 表示独享带宽 1 表示共享带宽
  band_width_size	否 当band_width_share_type为共享带宽时必选	Integer	共享带宽默认取值范围5Mbit/s~2000Mbit/s 独享带宽的默认带宽是300Mbit/s。 说明： 具体范围以各区域配置为准，请参见控制台对应页面显示。

  表3 extend_param数据结构说明

  参数	是否必选	参数类型	描述
  charging_mode	是	Integer	计费类型 0 表示包周期
  period_type	是	Integer	订购周期类型 2 表示月 3 表示年
  period_num	是	Integer	订购周期数 当订购周期为月时，取值范围[1, 9]。 当订购周期为年时，取值范围[1,10]。
  is_auto_pay	否	Integer	是否自动付款。默认不自动付款。 1 表示自动付款 0 表示不自动付款

  表4 port结构体数组

  参数	是否必选	参数类型	描述
  name	是	String	应用端口名称，不超过16个字节，系统关键服务名称不能使用"adb"和"vnc"。
  listen_port	是	Integer	端口号，大于等于10000，小于等于50000
  internet_accessible	是	String	为"true"则映射出公网访问（忽略大小写）。 为其他则不映射。

• 请求样例

  POST https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phones
  {
      "server_name": "myPhoneServer",
      "server_model_name": "physical.rx1.xlarge",  
      "phone_model_name": "aphs1.medium.4.aosp",  
      "image_id": "88b8449b896f3a4f0ad57222dd919899", 
      "count": 3,   
      "keypair_name": "mykeypair",
          "ports": [         
  
          {
              "name": "myServer1",
              "listen_port": 20000,
              "internet_accessible": "false"
          },
          {
              "name": "myServer2",
              "listen_port": 20001,
              "internet_accessible": "true"
          }
      ],
      "band_width":{
          "band_width_share_type": 0 
      },
      "extend_param": {
          "charging_mode": 0,
          "period_type": 2, 
          "period_num": 1, 
          "is_auto_pay": 1
      }
  }

响应消息

• 响应参数

  参数	参数类型	描述
  request_id	String	请求的唯一标识ID。不超过32个字节。
  order_id	String	订单ID，不超过64个字节。
  product_id	String	产品ID，不超过64个字节。

• 响应样例

  {   
      "request_id": "1564567b8bab40f34711234cb80d8574",
      "order_id": "CS1710111105S8IPB", 
      "product_id": "00301-25217-0--0"
  }

返回值

请参考返回值。

错误码

请参考错误码。