华为云用户手册

云手机API 响应参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 error_code String 错误码，详情请参见错误码。 error_msg String 错误描述信息。 响应样例 { "request_id": "aad0860d089c482b943971f802a6718e", "error_code": "CPS.0001", "error_msg": "No permission to request resources." }

云手游API 响应参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 error_code String 错误码。 error_msg String 错误描述信息。 failures Array of objects 操作对象异常的说明，详情请参见表1。 表1 failures数据结构说明 参数 参数类型 描述 server_id String 云手机服务器ID。 error_code String 错误码。 error_msg String 错误描述信息。 响应样例 { "request_id": "6837531fd3f54550927b930180a706bf", "error_code": "CPS.1040", "error_msg": "App pool cannot be scaled down.", "failures": [ { "server_id": "1564567b8bab40f34711234cb80d0124", "error_code": "CPS.1027", "error_msg": "Server is being scaled up." }, { "server_id": "1564567b8bab40f34711234cb80d0188", "error_code": "CPS.1028", "error_msg": "No permission to request resources. Server is frozen." } ]}

概述 欢迎使用云手机服务器服务（Cloud Phone Host，CPH）。云手机服务器是基于华为云裸金属服务器，虚拟出带有原生安卓操作系统，同时具有虚拟手机功能的云服务器。 您可以使用本文档提供的API对云手机服务器服务进行相关操作，如购买云手机服务器、查询云手机列表、查询云手机上部署的应用、修改共享带宽、重启云手机等。支持的全部操作请参见API概览。 在调用云手机服务器服务API之前，请确保已经充分了解云手机服务器服务相关概念，详细信息请参见“产品介绍”。 父主题： 使用前必读

响应示例 状态码： 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 } } ]}

响应参数 状态码： 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：云手游 表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数量。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 band_width_size 是 Integer 小于等于300Mbit/s：默认最小增长步长为1Mbit/s。 300Mbit/s~1000Mbit/s：默认最小增长步长为50Mbit/s。 大于1000Mbit/s：默认最小增长步长为500Mbit/s。

请求示例 购买系统定义网络云手机服务器 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 }}

响应示例 状态码： 200 OK { "request_id" : "1564567b8bab40f34711234cb80d8574", "order_id" : " CS 1710111105S8IPB", "product_id" : "00301-25217-0--0", "server_ids" : [ "1234567b8bab40ffb711234cb80d0234", "1678567b8bab40f93711234cb80d0764" ]}

请求参数 表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 云手机启用的应用端口，云手机服务会做端口转发。 band_width 是 band_width object 云手机使用的带宽信息。独占带宽按流量计费，共享带宽可选择带宽大小。 extend_param 是 extend_param object 计费模式参数。 vnc_enable 否 String (已废弃)是否开启VNC方式登录云手机。 为"true"时开启（忽略大小写）。 为其他，则不开启 subnet_cidr 否 String 服务器的子网信息，第一次购买系统会自动创建172.31.0.0/16的子网。需要自定义子网的客户，需要全部通过 API购买 ，设置的子网，必须是子网的格式且和已有子网不能重叠。 表4 Port 参数 是否必选 参数类型 描述 name 是 String 应用端口名称，不超过16个字节，系统关键服务名称不能使用"adb"和"vnc"。 listen_port 是 Integer 端口号，大于等于10000，小于等于50000。 internet_accessible 是 String 为"true"则映射出公网访问（忽略大小写）。 为其他则不映射。 表5 band_width 参数 是否必选 参数类型 描述 band_width_id 否 String 云手机服务器的带宽唯一标识。 band_width_size 否 Integer 云手机服务器的带宽大小。 band_width_share_type 否 Integer 云手机服务器的带宽类型。 0：per，独享带宽 1：whole，共享带宽 表6 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”），则将资源绑定给默认企业项目。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 band_widths Array of Bandwidth objects 带宽信息。 表5 Bandwidth 参数 参数类型 描述 band_width_name String 云手机服务器的带宽名称。 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，共享带宽 create_time String 带宽创建时间， 时间格式为UTC，YYYY-MM-DDTHH:MM:SSZ。 update_time String 带宽更新时间， 时间格式为UTC，YYYY-MM-DDTHH:MM:SSZ。

响应示例 状态码： 200 OK { "request_id" : "70bb40bef50e4a14b116a5a527fd7432", "band_widths" : [ { "band_width_id" : "70bb40-bef5-0e4a-14b116-a5a527fd7432", "band_width_name" : "BANDW IDT H_70bb40bef50e4a14b116a5a527fd7432", "band_width_size" : 300, "band_width_share_type" : 1, "create_time" : "2017-10-10T00:00:00Z", "update_time" : "2018-11-12T00:00:00Z" } ]}

URI GET /v1/{project_id}/cloud-phone/bandwidths 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量为一个大于0小于资源总个数的整数，表示查询该偏移量后面的所有的资源数，默认值为0。 limit 否 Integer 每页返回的资源个数。取值范围：1~100（默认值为100），一般设置为10、20、50。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 image_id 否 String 云手机镜像。 phones 是 Array of PhoneProperty objects 云手机列表。 表4 PhoneProperty 参数 是否必选 参数类型 描述 phone_id 是 String 云手机id。 property 否 String 云手机属性列表，为Json格式字符串。

响应示例 状态码： 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 错误说明。

请求示例 批量重置云手机，选择更换镜像和属性 POST https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phones/batch-reset{ "phones" : [ { "phone_id" : "a7f3a1c5258347d6b6f1def79e11f2bc", "property" : "{\"sys.prop.writephonenum\":\"13666666666\",\"sys.prop.writeimsi\":\"460021624617113\",\"sys.prop.writewifissid\":\"test_wifi\"}" }, { "phone_id" : "1678567b8bab40f93711234cb80d0764", "property" : "{\"sys.prop.writephonenum\":\"13666666666\",\"sys.prop.writeimsi\":\"460021624617113\",\"sys.prop.writewifissid\":\"test_wifi\"}" } ], "image_id" : "1564567b8bab40f34711234cb80d8574"}

响应参数 状态码： 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 表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" : "6837531fd3f54550927b930180a706bf", "jobs" : [ { "phone_id" : "1234567b8bab40ffb711234cb80d0234", "job_id" : "1564567b8bab40f34711234cb80d0123" }, { "phone_id" : "1678567b8bab40f93711234cb80d0764", "job_id" : "1564567b8bab40f34711234cb80d5678" } ]}

请求示例 向手机列表中的手机异步执行shell命令，命令为ls -l /system POST https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phones/commands{ "command" : "shell", "content" : "ls -l /system", "phone_ids" : [ "1234567b8bab40ffb711234cb80d0234", "1678567b8bab40f93711234cb80d0764" ]}

请求示例 在云手机中卸载apk。 POST https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phones/commands{ "command" : "uninstall", "content" : "com.myapp.test", "phone_ids" : [ "1234567b8bab40ffb711234cb80d0234", "1678567b8bab40f93711234cb80d0764" ]}

响应参数 状态码： 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 错误说明。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 command 是 String ADB命令，固定填写shell。 content 是 String 待执行的命令。 最大长度为1024字节，只支持大小写字母、数字、下划线（_）、点（.）、斜线（/）、冒号（:）、中划线（-）。 phone_ids 否 Array of strings 云手机ID列表。 server_ids参数不存在时必选，同时存在只处理phone_ids。 server_ids 否 Array of strings 云手机服务器ID列表。 phone_ids参数不存在时必选，同时存在只处理phone_ids。

响应示例 状态码： 200 OK { "request_id" : "6837531fd3f54550927b930180a706bf", "jobs" : [ { "phone_id" : "1234567b8bab40ffb711234cb80d0234", "job_id" : "1564567b8bab40f34711234cb80d0123" }, { "phone_id" : "1678567b8bab40f93711234cb80d0764", "job_id" : "1564567b8bab40f34711234cb80d5678" } ]}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 command 是 String 卸载应用固定填写uninstall。 content 是 String 待卸载的APP名称。 最大长度为1024字节，只支持大小写字母、数字、下划线（_）、点（.）、斜线（/）、冒号（:）、中划线（-）。 phone_ids 否 Array of strings 云手机ID列表。 server_ids参数不存在时必选，同时存在只处理phone_ids。 server_ids 否 Array of strings 云手机服务器ID列表。 phone_ids参数不存在时必选，同时存在只处理phone_ids。

响应示例 状态码： 200 OK { "server_name" : "cph-418540-1620-40-old-1", "availability_zone" : "br-iaas-odin1a", "addresses" : [ { "public_ip" : "10.246.xxx.xxx", "server_ip" : "172.31.22.245", "intranet_ip" : "172.31.22.245", "access_ip" : "10.246.xxx.xxx" } ], "metadata" : { "product_id" : "OFFI451249149551403012", "order_id" : "CS2007271727F9XJE" }, "create_time" : "2020-01-01T00:00:00Z", "vpc_id" : "12021c68-730f-41fa-9884-11c616f4c9ad", "phone_model_name" : "kg1.cg.c40.d30SSD.e1v1.old", "subnet_cidr" : "172.31.0.0/16", "keypair_name" : "KeyPair-1230", "resource_project_id" : "06a5b529fa80d28b2f53c014024bed44", "server_id" : "6edb89150bc742aa81fc8ac4ff047297", "server_model_name" : "physical.kg1.4xlarge.cg", "update_time" : "2020-01-01T00:00:00Z", "cidr" : "172.31.0.0/16", "vpc_cidr" : "172.31.0.0/16", "subnet_id" : "5784d2fe-fefd-42f0-a7f1-e88454d8bc0f", "request_id" : "91d5bf46a817466daa25fc5824ab9717", "status" : 5, "network_version" : "v1", "security_groups" : [ ]}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 server_name String 云手机服务器名称， 不超过65字符，只支持英文字母、数字、汉字、下划线和中划线。 availability_zone String 云手机服务器所在的可用区。 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。 resource_project_id String 云手机服务器的项目ID。 metadata metadata object 订单以及产品相关信息。 addresses Array of Address objects 云手机服务器的IP相关信息。 band_widths Array of Bandwidth objects 云手机服务器带宽信息的结构体数组。 volumes Array of Volume objects 云手机服务器卷信息的结构体数组。 network_version String 是否为自定义网络的云手机服务器标识。"v1"，非自定义网络的云手机服务器。"v2"，自定义网络的云手机服务器。支持按照网络版本字段进行筛选。 enterprise_project_id String 云手机服务器所属企业项目ID。 security_groups Array of strings 服务器扩展网卡绑定的安全组信息。 系统定义网络的服务器，该字段返回为空列表。 create_time String 创建时间， 时间格式为UTC，YYYY-MM-DDTHH:MM:SSZ。 update_time String 更新时间， 时间格式为UTC，YYYY-MM-DDTHH:MM:SSZ。 表4 metadata 参数 参数类型 描述 product_id String 订单ID，不超过64个字节。 order_id String 产品ID，不超过64个字节。 表5 Address 参数 参数类型 描述 intranet_ip String 云手机服务器的内网IP，过期字段。 access_ip String 云手机服务器的公网IP，过期字段。 server_ip String 云手机服务器的内网IP，新增字段。 public_ip String 云手机服务器的公网IP，新增字段。 表6 Bandwidth 参数 参数类型 描述 band_width_name String 云手机服务器的带宽名称。 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，共享带宽 create_time String 带宽创建时间， 时间格式为UTC，YYYY-MM-DDTHH:MM:SSZ。 update_time String 带宽更新时间， 时间格式为UTC，YYYY-MM-DDTHH:MM:SSZ。 表7 Volume 参数 参数类型 描述 volume_name String 云手机服务器的硬盘名称。 volume_id String 云手机服务器的硬盘唯一标识。 volume_size Integer 云手机服务器的硬盘大小，单位G。 volume_type String 云手机服务器的硬盘类型。 create_time String 硬盘创建时间， 时间格式为UTC，YYYY-MM-DDTHH:MM:SSZ。 update_time String 硬盘更新时间， 时间格式为UTC，YYYY-MM-DDTHH:MM:SSZ。

响应参数 状态码： 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： 失败 error_msg String 任务错误码说明。 error_code String 任务错误码。 execute_msg String 任务执行返回内容，最长1024个字节。

响应示例 状态码： 200 OK { "error_msg" : null, "execute_msg" : null, "job_id" : "6837531fd3f54550927b930180a706bf", "end_time" : "2019-04-26T07:00:06Z", "begin_time" : "2019-04-26T07:00:00Z", "error_code" : null, "request_id" : "2676a3b4f7df49c297c6775989806d32", "status" : 2}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 jobs Array of ServerJob objects 任务列表。 表5 ServerJob 参数 参数类型 描述 server_id String 云手机服务器的唯一标识ID，云手机服务器相关任务包含此字段。 job_id String 任务的唯一标识。 error_code String 错误码。 error_msg String 错误说明。