华为云用户手册

  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 操作标识。 create:创建 tags 是 Array of Tag objects 标签列表。 表4 Tag 参数 是否必选 参数类型 描述 key 是 String 键。 最大长度127个unicode字符。 不能为空,可以包含任意语种字母、数字、空格和_.:=+-@,不能以_sys_开头。 value 是 String 值列表。 每个值最大长度255个unicode字符。 不能为空,可以包含任意语种字母、数字、空格和_.:=+-@,但首尾不能含有空格。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 tags Array of Tag objects 资源标签列表。 表4 Tag 参数 参数类型 描述 key String 键。 最大长度127个unicode字符。 不能为空,可以包含任意语种字母、数字、空格和_.:=+-@,不能以_sys_开头。 value String 值列表。 每个值最大长度255个unicode字符。 不能为空,可以包含任意语种字母、数字、空格和_.:=+-@,但首尾不能含有空格。
  • 请求示例 购买云手机服务器 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" : " CS 1710111105S8IPB", "product_id" : "00301-25217-0--0", "server_ids" : [ "1234567b8bab40ffb711234cb80d0234", "1678567b8bab40f93711234cb80d0764" ] }
  • 响应参数 状态码: 200 表13 响应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 任务错误码。
  • 请求参数 表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 表3 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 job_id String 任务的唯一标识。 begin_time String 任务处理开始时间,时间格式为UTC,YYYY-MM-DDTHH:MM:SSZ。 end_time String 任务处理结束时间,时间格式为UTC,YYYY-MM-DDTHH:MM:SSZ。 status Integer 任务状态。 1: 运行中 2: 成功 -1: 失败 phone_id String 云手机的唯一标识,云手机相关任务包含此字段。 server_id String 云手机服务器的唯一标识ID,云手机服务器相关任务包含此字段。 error_msg String 任务错误码说明。 error_code String 任务错误码。 execute_msg String 任务执行返回内容,最长1024个字节。
  • 响应示例 状态码: 200 OK { "error_msg" : null, "execute_msg" : null, "job_id" : "6837531fd3f54550927b930180a706bf", "phone_id" : "9b28fbe50ded4060b8149a47e55dba82", "end_time" : "2019-04-26T07:00:06Z", "begin_time" : "2019-04-26T07:00:00Z", "error_code" : null, "request_id" : "2676a3b4f7df49c297c6775989806d32", "status" : 2 }
  • 响应示例 状态码: 200 OK { "request_id" : "6837531fd3f54550927b930180a706bf", "jobs" : [ { "phone_id" : "1234567b8bab40ffb711234cb80d0234", "job_id" : "1564567b8bab40f34711234cb80d0123" }, { "phone_id" : "1678567b8bab40f93711234cb80d0764", "error_code" : "CPS.0004", "error_msg" : "Parameter: phone_id is invalid." } ] }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 jobs Array of PhoneJob objects 任务信息。 表6 PhoneJob 参数 参数类型 描述 phone_id String 云手机的唯一标识ID,云手机相关任务包含此字段。 job_id String 任务的唯一标识。 error_code String 错误码。 error_msg String 错误说明。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 phones 是 Array of PhoneDataVolumeSize objects 云手机列表。 表4 PhoneDataVolumeSize 参数 是否必选 参数类型 描述 phone_id 是 String 云手机id new_size 是 Integer 扩容后的手机数据盘大小,单位为GiB。扩容的大小必须大于等于原有容量且小于最大容量。 最大容量:32768GiB
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 phone_name 是 String 云手机名称,必须为小写字母(a-z)、大写字母(A-Z)、数字(0-9)、中文字符、中划线-、下划线_,且不得超过60个字符。
  • 响应示例 状态码: 200 OK { "request_id" : "6837531fd3f54550927b930180a706bf", "jobs" : [ { "phone_id" : "1234567b8bab40ffb711234cb80d0234", "job_id" : "1564567b8bab40f34711234cb80d0123" }, { "phone_id" : "1678567b8bab40f93711234cb80d0764", "job_id" : "1564567b8bab40f34711234cb80d5678" } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 jobs Array of PhoneJob objects 任务信息。 表5 PhoneJob 参数 参数类型 描述 phone_id String 云手机的唯一标识ID,云手机相关任务包含此字段。 job_id String 任务的唯一标识。 error_code String 错误码。 error_msg String 错误说明。
  • 响应示例 状态码: 200 OK { "phone_images" : [ { "image_name" : "AOSP", "os_type" : "aosp", "is_public" : 1, "os_name" : "AOSP7.1.1", "image_label" : "cloud_game", "image_id" : "20032420200401a60b0003a99684b8ea" }, { "image_name" : "AOSP", "os_type" : "aosp", "is_public" : 1, "os_name" : "AOSP7.1.1", "image_label" : "cloud_phone", "image_id" : "20032120200330a20b000eae5b8c01e6" }, { "image_name" : "AOSP", "os_type" : "aosp", "is_public" : 1, "os_name" : "AOSP7.0.0", "image_label" : "qemu_phone", "image_id" : "be4d231e44d2a4ccf612660a473fe1e3" } ], "request_id" : "5aac6ab146ba76e5b12a3d00a03a9869" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 phone_images Array of PhoneImage objects 手机镜像信息。 表5 PhoneImage 参数 参数类型 描述 image_name String 手机镜像名称,不超过128个字节。 os_type String 镜像操作系统类型,不超过16个字节。 is_public Integer 镜像类型。 1:公有镜像 2 :私有镜像 os_name String 手机操作系统,不超过36个字节。 image_label String 镜像适用的云手机规格。 cloud_phone:适用于physical.rx1.xlarge 类型云手机服务器 cloud_phone_1620:适用于physical.kg1.4xlarge.cp类型云手机服务器 cloud_game:适用于physical.rx1.xlarge.cg 类型云手游服务器 cloud_game_1620:适用于physical.kg1.4xlarge.cg 类型云手游服务器 qemu_phone: 适用于physical.rx1.xlarge 类型云手机服务器中 qemu类型云手机规格 image_id String 手机镜像唯一标识ID,不超过32个字节。 is_support_encrypt Boolean 当前镜像是否支持文件级加密
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 count Integer 实例总数。 servers Array of Server objects 云手机服务器信息。 表5 Server 参数 参数类型 描述 server_name String 云手机服务器名称,不超过65字符,只支持英文字母、数字、汉字、下划线和中划线。 availability_zone String 云手机服务器所在的可用区。如上海一可用区1为cn-east-3a。 server_id String 云手机服务器的唯一标识,不超过32个字节。 server_model_name String 云手机服务器规格名称,不超过64个字节。 phone_model_name String 云手机规格名称,不超过64个字节。 keypair_name String 连接云手机所使用的密钥对的名称,不超过64个字节。 status Integer 服务器状态。 0、1、3、4:创建中 2:异常 5:正常 8:冻结 10:关机 11:关机中 12:关机失败 13:开机中 vpc_id String 云手机服务器所属虚拟私有云(简称VPC)的ID。 网络版本network_version取值为“v1”时,表示云手机服务器所属资源租户的VPC ID;取值为“v2”时,表示租户创建服务器时指定VPC的 VPC ID。 cidr String 云手机服务器所属虚拟私有云(简称VPC)的网段。网络版本 network_version 取值为“v1”时,表示云手机服务器所属资源租户的VPC CIDR;取值为“v2”时,表示租户创建服务器时指定 VPC 的 VPC CIDR。 vpc_cidr String 云手机服务器所属虚拟私有云(简称VPC 网络版本 network_version 取值为“v1”时,表示云手机服务器所属资源租户的VPC CIDR;取值为“v2”时,表示租户创建服务器时指定 VPC 的 VPC CIDR subnet_id String 云手机服务器所属子网的ID。仅在网络版本 network_version 取值为“v2”时,该取值表示租户创建服务器时指定子网的 ID,网络版本取值为“v1”时,该字段表示云手机服务器所属资源租户的子网ID。 subnet_cidr String 云手机服务器所属子网网段。网络版本 network_version 取值为“v2”时,表示租户创建服务器时指定子网的 CIDR; 取值为“v1”时,表示云手机服务器所属资源租户的子网CIDR。 addresses Array of Address objects 云手机服务器的IP相关信息。 resource_project_id String 云手机服务器的项目ID。用于对使用系统定义网络的服务器创建对等连接,并非租户的项目ID。 metadata metadata object 订单以及产品相关信息。 network_version String 是否为自定义网络的云手机服务器标识。"v1",非自定义网络的云手机服务器。 "v2",自定义网络的云手机服务器。支持按照网络版本字段进行筛选。 enterprise_project_id String 云手机服务器所属企业项目ID。 create_time String 创建时间, 时间格式为UTC,YYYY-MM-DDTHH:MM:SSZ。 update_time String 更新时间, 时间格式为UTC,YYYY-MM-DDTHH:MM:SSZ。 表6 Address 参数 参数类型 描述 intranet_ip String 云手机服务器的内网IP,过期字段。 access_ip String 云手机服务器的公网IP,过期字段。 server_ip String 云手机服务器的内网IP,新增字段。 public_ip String 云手机服务器的公网IP,新增字段。 表7 metadata 参数 参数类型 描述 product_id String 订单ID,不超过64个字节。 order_id String 产品ID,不超过64个字节。 charging_mode Integer 计费类型。 0:包周期
  • 响应示例 状态码: 200 OK { "servers" : [ { "server_name" : "cph-edgr-1", "server_id" : "4aff349ab539452a85ac5d7442b39377", "server_model_name" : "physical.rx1.xlarge", "phone_model_name" : "rx1.cp.c105.d6.e5v5", "keypair_name" : "keypair01", "status" : 2, "vpc_id" : "9a11e291-967f-4dd6-99bd-9be54f10583c", "cidr" : "192.168.0.0/16", "vpc_cidr" : "192.168.0.0/16", "subnet_id" : "c7f9983d-03ca-4a2e-a0e1-d6bd97174669", "subnet_cidr" : "192.168.0.0/24", "addresses" : [ { "intranet_ip" : "192.168.0.62", "server_ip" : "192.168.0.62", "access_ip" : "10.246.175.190", "public_ip" : "10.246.175.190" }, { "intranet_ip" : "192.168.0.169", "server_ip" : "192.168.0.169", "access_ip" : "10.246.171.245", "public_ip" : "10.246.171.245" } ], "resource_project_id" : "06a5b529fa80d28b2f53c014024bed44", "metadata" : { "product_id" : "00301-221014-0--0", "order_id" : "CS21111116336E8RX", "charging_mode" : 0 }, "availability_zone" : "xxxxxx", "network_version" : "v2", "create_time" : "2021-11-11T08:33:40Z", "update_time" : "2021-11-11T09:28:30Z" }, { "server_name" : "cph-igfp-2", "server_id" : "6d74b672216d40f39377a99e7f95aa95", "server_model_name" : "physical.kg1m.4xlarge.cg", "phone_model_name" : "kg1m.cg.c60.d20SSD.e1v1", "keypair_name" : "KeyPair-2", "status" : 2, "vpc_id" : "12021c68-730f-41fa-9884-11c616f4c9ad", "cidr" : "172.31.0.0/16", "vpc_cidr" : "172.31.0.0/16", "subnet_id" : "92cf2447-163c-4fe8-897b-fd262ab6b134", "subnet_cidr" : "172.31.0.0/16", "addresses" : [ { "intranet_ip" : "172.31.185.82", "access_ip" : "88.88.48.151", "server_ip" : "172.31.185.82", "public_ip" : "88.88.48.151" } ], "resource_project_id" : "06a5b529fa80d28b2f53c014024bed44", "metadata" : { "product_id" : "OFFI635412973496623104", "order_id" : "CS21083015171L1CA", "charging_mode" : 0 }, "availability_zone" : "xxxxxx", "network_version" : "v1", "create_time" : "2021-08-30T07:17:40Z", "update_time" : "2021-11-05T09:07:57Z" } ], "request_id" : "4336f6c61d2048c6b58b4368d9d95ecd", "count" : 2 }
  • URI GET /v1/{project_id}/cloud-phone/servers 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量为一个大于等于0整数,表示查询该偏移量后面的所有的资源数,默认值为0。 limit 否 Integer 每页返回的资源个数。取值范围:1~100(默认值为100),一般设置为10、20、50。 server_name 否 String 云手机服务器名称,支持模糊查询。 server_id 否 String 云手机服务器的唯一标识。 network_version 否 String 云手机服务器是否为自定义网络标识。 v1:系统定义网络的云手机服务器 v2:自定义网络的云手机服务器 phone_model_name 否 String 手机规格名称。 create_since 否 Long 查询的起始时间戳。 create_until 否 Long 查询的结束时间戳。 status 否 Integer 服务器状态。 0、1、3、4:创建中 2:异常 5:正常 8:冻结 10:关机 11:关机中 12:关机失败 13:开机中
  • 响应示例 状态码: 200 OK { "request_id" : "4d4aefaa7b1d4a2bb5637e9d5631342f", "server_models" : [ { "server_model_name" : "physical.rx1.xlarge", "server_type" : "Hi1616", "cpu" : 64, "memory" : 256, "extend_spec" : { "cpu" : "Hi1616(2*32Core*2.4GHz)", "memory" : "DDR4 RAM ", "disk" : "2*1.2T SAS + 800G SSD", "network_interface" : "2 x 2*10GE", "gpu" : "3*WX5100", "bms_flavor" : "physical.rg1.xlarge.cph.ondemand", "gpu_count" : 3, "numa_count" : 4 }, "product_type" : 0, "free_size" : 0 } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 server_models Array of ServerModel objects 云手机服务器的规格信息。 表5 ServerModel 参数 参数类型 描述 server_model_name String 云手机服务器的规格名称,不超过64字节。 server_type String 云手机服务器的型号,如Hi1616。不超过32字节。 cpu Integer 云手机服务器的CPU核数。 memory Integer 云手机服务器的内存大小,单位G。 extend_spec extend_spec object 云手机服务器的属性描述,不超过512个字节。 product_type Integer 产品类型。 0:云手机 1:云手游 free_size Integer 服务器磁盘的免费配额,单位G。 表6 extend_spec 参数 参数类型 描述 cpu String 云手机服务器cpu类型。 memory String 云手机服务器内存类型。 disk String 云手机服务器磁盘类型。 network_interface String 云手机服务器网络类型。 gpu String 云手机服务器gpu类型。 bms_flavor String 云手机服务器bms规格。 gpu_count Integer 云手机服务器gpu数量。 numa_count Integer 云手机服务器numa数量。 os_volume os_volume object 云盘服务器操作系统盘信息,本地盘服务器不返回 表7 os_volume 参数 参数类型 描述 size Integer 操作系统盘大小 volume_type String 操作系统盘类型
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 server_name 是 String 云手机服务器名称,必须为小写字母(a-z)、大写字母(A-Z)、数字(0-9)、中文字符、中划线-、下划线_,且不得超过60个字符。
  • 请求示例 批量重启encode_server_ids列表中的服务器上的编码容器 POST https://{CPH Endpoint}/v1/{project_id}/cloud-phone/encode-servers/batch-restart { "encode_server_ids" : [ "d5cfa92995da40168c39b38d2aa478b3", "00b00d1b35094f13b360cdfe15a9bfee" ] }
  • 响应示例 状态码: 200 OK { "jobs" : [ { "job_id" : "e9d7b1a2572c4f2c9bf056a3d1b35e39", "encode_server_id" : "d5cfa92995da40168c39b38d2aa478b3" }, { "job_id" : "4d0a42447cac4c9697b97f07934b74bd", "encode_server_id" : "00b00d1b35094f13b360cdfe15a9bfee" } ], "request_id" : "c775bdf09bc0400a9138199b346cab62" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 jobs Array of EncodeServerJob objects 任务信息。 表5 EncodeServerJob 参数 参数类型 描述 encode_server_id String 编码服务的唯一标识ID,编码服务相关任务包含此字段。 job_id String 任务的唯一标识。 error_code String 错误码。 error_msg String 错误说明。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 tags Array of Tags objects 资源标签列表。 表4 Tags 参数 参数类型 描述 key String 键。 最大长度127个unicode字符。 key不能为空。 values Array of strings 值列表。 最多10个value。 value不允许重复。 每个值最大长度255个unicode字符。 如果values为空则表示any_value。 value之间为或的关系。
  • 响应示例 状态码: 200 OK { "request_id" : "70bb40bef50e4a14b116a5a527fd7432", "phone_name" : "mobile-0049", "server_id" : "88b8449b896f3a4f0ad57222dd91909", "phone_id" : "1564567b8bab40f34711234cb80d8574", "image_id" : "88b8449b896f3a4f0ad57222dd91909", "phone_model_name" : "aphs1.large.2.aosp", "image_version" : "AOSP 7.0", "status" : 2, "imei" : 869287243397729, "type" : 0, "availability_zone" : "xxxxxx", "traffic_type" : "direct", "volume_mode" : 0, "phone_data_volume" : { "volume_type" : "GPSSD", "volume_size" : 10 }, "access_infos" : [ { "type" : "server1", "device_ip" : "10.237.0.61", "phone_ip" : "10.237.0.61", "listen_port" : 38080, "access_ip" : "213.32.43.210", "public_ip" : "213.32.43.210", "intranet_ip" : "172.31.0.123", "server_ip" : "172.31.0.123", "access_port" : 14308, "phone_ipv6" : "fd00::aed:3d", "server_ipv6" : "2001:db8:a583:b62:e5ea:4a6b:de7b:f97d" }, { "type" : "server2", "device_ip" : "10.237.0.61", "phone_ip" : "10.237.0.61", "listen_port" : 38081, "access_ip" : "213.32.43.210", "public_ip" : "213.32.43.210", "intranet_ip" : "172.31.0.123", "server_ip" : "172.31.0.123", "access_port" : 14328, "phone_ipv6" : "fd00::aed:3d", "server_ipv6" : "2001:db8:a583:b62:e5ea:4a6b:de7b:f97d" } ], "property" : "{\"sys.prop.writephonenum\":\"13666666666\",\"sys.prop.writeimsi\":\"460021624617113\",\"sys.prop.writewifissid\":\"test_wifi\"}", "metadata" : { "order_id" : "CS1710111105S8IPB", "product_id" : "00301-25217-0--0" }, "create_time" : "2017-10-10T00:00:00Z", "update_time" : "2018-11-12T00:00:00Z" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID,不超过32个字节。 phone_name String 云手机名称,不超过65个字符。 server_id String 云手机服务器ID,不超过32个字节。 phone_id String 云手机的唯一标识,不超过32个字节。 image_id String 云手机镜像ID,不超过32个字节。 image_version String 镜像版本。 vnc_enable String 云手机是否开启VNC服务(过期) true:开启 false:关闭 phone_model_name String 云手机规格名称,不超过64个字节。 status Integer 云手机状态。 1:创建中 2:运行中 3:重置中 4:重启中 6:冻结 7:正在关机 8:已关机 -5:重置失败 -6:重启失败 -7:手机异常 -8:创建失败 -9:关机失败 access_infos Array of PhoneAccessInfo objects 云手机访问信息。 property String 云手机属性字符串,不超过2048个字节。 metadata metadata object 订单以及产品相关信息。 phone_data_volume PhoneDataVolume object 云手机数据盘信息。 imei String imei码。 type Integer 云手机类型。 0:普通云手机 traffic_type String 手机路由类型。 direct:默认路由 routing:路由到编码容器 volume_mode Integer 手机物理磁盘是否独立。 0:不独立 1:独立 availability_zone String 云手机服务器所在的可用区。如上海一可用区1为cn-east-3a。 has_encrypt Boolean 当前手机是否开启文件级加密。 create_time String 创建时间, 时间格式为UTC,YYYY-MM-DDTHH:MM:SSZ。 update_time String 更新时间, 时间格式为UTC,YYYY-MM-DDTHH:MM:SSZ。 表4 PhoneAccessInfo 参数 参数类型 描述 type String 自定义端口类型,不超过16个字节。 device_ip String 云手机IP(过期)。 phone_ip String 云手机IP。 listen_port Integer 服务监听端口。 access_ip String 云手机服务器的访问IP(过期)。 public_ip String 云手机服务器的公网IP,如果端口设置了非公网访问,该字段返回空字符串。 intranet_ip String 云手机服务器的内网IP(过期)。 server_ip String 云手机服务器的内网IP。 access_port Integer 服务映射到公网的访问端口。 phone_ipv6 String 云手机IPv6 IP,新增字段。 server_ipv6 String 云手机服务器IPv6 IP,新增字段。 表5 metadata 参数 参数类型 描述 order_id String 订单ID,不超过64个字节。 product_id String 产品ID,不超过64个字节。 表6 PhoneDataVolume 参数 参数类型 描述 volume_type String 云手机数据盘类型。 volume_size Integer 云手机数据盘大小。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 traffic_type 是 String 手机路由类型。 direct:默认路由 routing:路由到编码容器 phone_ids 是 Array of strings 手机id列表,一次调用最多支持100个。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 jobs Array of PhoneJob objects 任务列表。 表5 PhoneJob 参数 参数类型 描述 phone_id String 云手机的唯一标识ID,云手机相关任务包含此字段。 job_id String 任务的唯一标识。 error_code String 错误码。 error_msg String 错误说明。
共100000条