华为云用户手册

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

请求示例 将应用推送到服务器列表中的服务器上，应用来自于obs桶中 POST https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phones/share-apps { "package_name" : "com.miniteck.miniworld", "bucket_name" : "bucket", "object_path" : "my_apps/test.tar", "server_ids" : [ "1234567b8bab40ffb711234cb80d0234", "1678567b8bab40f93711234cb80d0764" ] }

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

功能介绍 推送应用tar文件至共享应用存储目录中，该功能仅在支持共享应用的云手机服务器上可实现。接口调用前请先确保已完成CPH服务操作OBS桶的委托授权。委托CPH操作OBS桶请参见委托CPH操作OBS桶。 注意：不能向存在低安卓版本云手机的服务器推送高安卓版本手机导出的应用包，否则可能会造成手机数据兼容性问题。如果您使用的是physical.kg1.4xlarge.a.cp服务器规格，请确保共享存储的可用空间大于两倍的tar包大小

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 package_name 是 String 合法的应用包名。 pre_install_app 否 Integer 是否预装应用。 1：预装 0：不预装；默认不预装 bucket_name 是 String 合法的OBS桶名，3-63个字符，只能由小写字母、数字、中划线（-）和小数点组成 object_path 是 String 合法的OBS对象key，最大长度1024字符。仅支持大小写字母、数字、小数点（.）、斜线（/）、中划线（-）、下划线（_）、加号（+）、井号（#）、等号等这些字符。 推送的文件只支持tar文件类型。推送时，按tar文件解压后的文件目录结构推送到手机。 server_ids 是 Array of strings 云手机服务器ID列表。传入的服务器id个数范围为[1, 100]。

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

响应示例 状态码： 200 OK { "request_id" : "6837531fd3f54550927b930180a706bf", "jobs" : [ { "server_id" : "ae4d231e44d2a4ccf612660a473fe1e3", "job_id" : "1564567b8bab40f34711234cb80d0123" }, { "server_id" : "2347275010d3440d963d3fcb8931ff55", "job_id" : "1564567b8bab40f34711234cb80d5678" } ] }

请求示例 修改服务器列表中对应服务器的密钥对 PUT https://{CPH Endpoint}/v1/{project_id}/cloud-phone/servers/open-access { "servers" : [ { "keypair_name" : "mykeypair", "server_id" : "ae4d231e44d2a4ccf612660a473fe1e3" }, { "keypair_name" : "mykeypair", "server_id" : "2347275010d3440d963d3fcb8931ff55" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 servers 是 Array of ServerKeypair objects 待更改密钥对的云手机服务器信息。 表4 ServerKeypair 参数 是否必选 参数类型 描述 server_id 是 String 云手机服务器ID，不得超过32个字节。 keypair_name 是 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。

请求示例 向手机列表中的手机异步执行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" ] }

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

响应示例 状态码： 200 OK { "server_name" : "cph-418540-1620-40-old-1", "availability_zone" : "xxxxxx", "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" : " CS 2007271727F9XJE" }, "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 云手机服务器所在的可用区。如上海一可用区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。 resource_project_id String 云手机服务器的项目ID。用于对使用系统定义网络的服务器创建对等连接，并非租户的项目ID。 metadata metadata object 订单以及产品相关信息。 addresses Array of Address objects 云手机服务器的IP相关信息。 band_widths Array of Bandwidth objects 云手机服务器带宽信息的结构体数组。 volumes Array of Volume objects 云手机服务器卷信息的结构体数组。 share_volume_info share_volume_info object 云手机服务器的共享存储相关信息。 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 参数 参数类型 描述 charging_mode Integer 计费类型。 0：包周期 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。 表8 share_volume_info 参数 参数类型 描述 volume_type String 共享存储磁盘类型。 size Integer 共享存储大小，单位G。 version Integer 共享存储版本： 0：共享存储1.0 1：共享存储2.0

响应参数 状态码： 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 卸载应用固定填写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 { "request_id" : "6837531fd3f54550927b930180a706bf", "jobs" : [ { "phone_id" : "1234567b8bab40ffb711234cb80d0234", "job_id" : "1564567b8bab40f34711234cb80d0123" }, { "phone_id" : "1678567b8bab40f93711234cb80d0764", "job_id" : "1564567b8bab40f34711234cb80d5678" } ] }

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

响应参数 状态码： 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-restart { "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 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." } ] }

请求参数 表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格式字符串。

请求示例 变更服务器的规格 POST https://{CPH Endpoint}/v1/{project_id}/cloud-phone/servers/change-server-model { "server_id" : "a176d8625981453bbafbc0a321d8d6a1", "server_model_name" : "physical.rx1.xlarge.special", "phone_model_name" : "rx1.cp.sp.c105.d8.e5v5", "extend_param" : { "is_auto_pay" : 1 } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 server_id 是 String 云手机服务器的唯一标识。只有特定的服务器才能操作变更规格。 server_model_name 是 String 目标云手机服务器规格，不超过64个字节。仅允许相同代系服务器之间的规格切换。 phone_model_name 是 String 目标云手机规格。要求与变更前云手机规格路数相同，与目标云手机服务器规格匹配。 extend_param 否 extend_param object 购买模式参数。 表4 extend_param 参数 是否必选 参数类型 描述 is_auto_pay 否 Integer 否自动付款。默认不自动付款。如果是规格升配的变更，则需要支付额外的费用，如果是降配的变更，则会自动退款。 1 ：自动付款 0 ：不自动付款

请求参数 表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。最多支持传入15个phone_id。 server_ids 否 Array of strings 云手机服务器ID列表。 phone_ids参数不存在时必选，同时存在只处理phone_ids。

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 jobs Array of RunSyncCommandJob objects 任务列表。 表5 RunSyncCommandJob 参数 参数类型 描述 phone_id String 云手机的唯一标识，云手机相关任务包含此字段。 job_id String 任务的唯一标识。 status Integer 任务状态 2：成功 1：运行中 -1：失败 error_code String 任务错误码。 error_msg String 任务错误码说明。 execute_msg String 任务执行返回内容，最长1024字节。

响应示例 状态码： 200 OK { "request_id" : "6837531fd3f54550927b930180a706bf", "jobs" : [ { "phone_id" : "1234567b8bab40ffb711234cb80d0234", "job_id" : "3fc17538866a4ff3a014d8bc6aaa4b69", "status" : -1, "error_code" : "CPS.0191", "error_msg" : "Run command failed.", "execute_msg" : "ls: cannot access '/system': No such file or directory" }, { "phone_id" : "1678567b8bab40f93711234cb80d0764", "job_id" : "1564567b8bab40f34711234cb80d5678", "status" : 2, "error_code" : "", "error_msg" : "", "execute_msg" : "xxxxx" } ] }

功能介绍 推送文件到云手机文件系统中。系统会将所指定的文件下载解压后，将解压后的内容全部推送到云手机的根目录下。只支持指定tar格式的文件进行推送，您需要将tar文件提前上传至您的OBS桶中。该接口为异步接口。接口调用前请先确保已完成CPH服务操作OBS桶的委托授权。委托CPH操作OBS桶请参见委托CPH操作OBS桶。 管理面性能有限，对相同服务器批量执行的ADB命令，将会阻塞云手机其他任务执行。 允许推送的文件大小限制为6G（即不可将obs桶内大于6G的文件推送到手机中），超过限制将返回错误。 手机的系统有限制，推送到系统盘不保证推送成功，推荐把文件推送到手机的数据盘。所以在构建"tar"文件时，应将待推送的文件放到本地创建的data目录后将其打包（如tar -cvf data.tar data ），以确保把文件推送到手机的数据盘下。