华为云用户手册

响应参数 状态码：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 ok { "resources" : [ { "resource_detail" : null, "resource_id" : "cdfs_cefs_wesas_12_dsad", "resource_name" : "resouece1", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value1" } ] } ], "total_count" : 1000 }

请求示例 查询资源实例数量 Post https://{CPH Endpoint}/v1/{project_id}/{resource_type}/resource_instances/action { "action" : "count", "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] }, { "key" : "key2", "values" : [ "value1", "value2" ] } ], "matches" : [ { "key" : "resource_name", "value" : "resource1" } ] } 查询资源实例列表 Post https://{CPH Endpoint}/v1/{project_id}/{resource_type}/resource_instances/action { "offset" : "100", "limit" : "100", "action" : "filter", "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] }, { "key" : "key2", "values" : [ "value1", "value2" ] } ], "matches" : [ { "key" : "resource_name", "value" : "resource1" } ] }

响应参数 状态码：200 表6 响应Body参数 参数 参数类型 描述 resources Array of Resource objects 资源列表。 total_count Integer 资源总数。 表7 Resource 参数 参数类型 描述 resource_id String 资源ID。 resource_detail String 资源详情。 resource_name String 资源名称。 tags Array of Tag objects 标签列表。 表8 Tag 参数 参数类型 描述 key String 键。 最大长度127个unicode字符。 不能为空，可以包含任意语种字母、数字、空格和_.：=+-@，不能以_sys_开头。 value String 值列表。 每个值最大长度255个unicode字符。 不能为空，可以包含任意语种字母、数字、空格和_.：=+-@，但首尾不能含有空格。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 操作标识（仅限于filter，count）：filter（过滤），count(查询总条数)。 为filter时表示分页查询，为count只需按照条件将总条数返回即可。 offset 否 String 索引位置， 从offset指定的下一条数据开始查询。 查询第一页数据时，不需要传入此参数，查询后续页码数据时，将查询前一页数据时响应体中的值带入此参数。action为count时无此参数。action为filter时，默认为0，必须为数字，且不能为负数。 limit 否 String 查询记录数。 action为count时无此参数。 action为filter时，默认为1000。limit最多为1000，不能为负数，最小值为1。 without_any_tag 否 Boolean 不包含任意一个标签，该字段为true时查询所有不带标签的资源。 tags 否 Array of Tags objects 最多包含10个key，每个key最多包含10个value，结构体不能缺失。key不能为空或者空字符串。key不能重复，同一个key中value不能重复，不同key对应的资源之间为与的关系。 matches 否 Array of Match objects 搜索字段。 key为要匹配的字段，当前只支持resource_name。 value为匹配的值，当前为精确匹配。 表4 Tags 参数 是否必选 参数类型 描述 key 是 String 键。 最大长度127个unicode字符。 key不能为空。 values 是 Array of strings 值列表。 最多10个value。 value不允许重复。 每个值最大长度255个unicode字符。 如果values为空则表示any_value。 value之间为或的关系。 表5 Match 参数 是否必选 参数类型 描述 key 是 String 键。 当前key的参数值只能取“resource_name”，此时value的参数值为资源名称。 value 是 String 值。 当前key的参数值只能取“resource_name”，此时value的参数值为资源名称。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 restore_infos 是 Array of RestoreInfo objects 待导入数据的云手机信息。 表4 RestoreInfo 参数 是否必选 参数类型 描述 phone_id 是 String 云手机ID。 bucket_name 是 String 导出数据存储的OBS桶名。 合法的OBS桶名，3-63个字符，只能由小写字母、数字、中划线（-）和小数点（.）组成。 object_path 是 String 导出数据存储的OBS路径名。 符合OBS的路径名规范，最大长度1024字符。

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

请求示例 将数据从obs桶恢复到云机 POST https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phones/batch-restore { "restore_infos" : [ { "phone_id" : "1234567b8bab40ffb711234cb80d0234", "bucket_name" : "mybucket", "object_path" : "myimage/v1/xxxx.tar" } ] }

功能介绍 批量恢复数据到云手机中。该接口为异步接口。接口调用前请先确保已完成CPH服务操作OBS桶的委托授权。委托CPH操作OBS桶请参见委托CPH操作OBS桶。 高版本手机导出的数据无法在低版本手机内恢复。低版本手机导出的数据可以在高版本手机内恢复，但可能会在极少数场景下有不兼容的风险。因此推荐您在同版本手机间进行导出与恢复。 手机在运行状态会有数据缓存，直接运行恢复的文件可能带来访问失败、应用崩溃等现象，建议在还原成功后重启手机，以保证云手机稳定运行。

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

响应示例 状态码：200 OK { "request_id" : "6837531fd3f54550927b930180a706bf", "jobs" : [ { "phone_id" : "1234567b8bab40ffb711234cb80d0234", "job_id" : "1564567b8bab40f34711234cb80d0123" }, { "phone_id" : "1678567b8bab40f93711234cb80d0764", "error_code" : "CPS.0005", "error_msg" : "Parameter: Phone not found." } ] }

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

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

URI GET /v1/{project_id}/cloud-phone/servers/share-files 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量为一个大于等于0整数，表示查询该偏移量后面的所有的资源数，默认值为0。 limit 否 Integer 每页返回的资源个数。取值范围：1~50（默认值为50）。 server_ids 是 String 云手机服务器ID列表，多个服务器ID用逗号（,）分隔。 path 是 String 待查询的目录名称， 可以包含大小写字母、数字、“.”、“+”、“-”、“_”、“/”、"="；必须以“/”开头，并且不能只包含“/”；不能包含“../”、“//”等。 示例：/data/data

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 package_name 是 String 所需删除的共享应用的合法包名。最大长度128字节。只支持包含大小写字母、数字、下划线、点，其中不允许以数字和下划线开头，点不能作为结尾且包名中至少有一个点。 server_ids 是 Array of strings 云手机服务器ID列表。

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

请求示例 删除服务器列表中服务器上的迷你世界 DELETE https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phones/share-apps { "package_name" : "com.miniteck.miniworld", "server_ids" : [ "1234567b8bab40ffb711234cb80d0234", "1678567b8bab40f93711234cb80d0764" ] }

请求示例 将手机数据导出到obs桶 POST https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phones/batch-storage { "storage_infos" : [ { "phone_id" : "1234567b8bab40ffb711234cb80d0234", "include_files" : [ "/data/app", "/data/local", "/data/media" ], "exclude_files" : [ "/data/app/com.xx.xx-*" ], "bucket_name" : "mybucket", "object_path" : "myimage/v1/xxxxx.tar" } ] }

响应参数 状态码：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参数 参数 是否必选 参数类型 描述 storage_infos 是 Array of StorageInfo objects 待导出数据的云手机信息。 表4 StorageInfo 参数 是否必选 参数类型 描述 phone_id 是 String 云手机ID。 include_files 是 Array of strings 需要导出数据的存储路径，绝对路径，最大长度4096字节。仅支持导出/data和、cache目录下的数据。目前只支持大小写字母、数字、小数点（.）、斜线（/）、中划线（-）、下划线（_）、加号（+）、井号（#）、星号（*）、等号这些字符。文件导出打包时仅保留路径最后一级的文件权限、属主、标签等元数据，如对文件的上层目录权限有要求，建议参考云手机数据备份与恢复。 exclude_files 否 Array of strings 不能导出数据的存储路径。exclude_files优先级比include_files高，如果冲突，exclude_files生效。 路径要求同include_files。 bucket_name 是 String 导出数据存储的OBS桶名。 合法的OBS桶名，3-63个字符，只能由小写字母、数字、中划线（-）和小数点（.）组成。 object_path 是 String 导出数据存储的OBS路径名。 符合OBS的路径名规范，最大长度1024字符。目前只支持大小写字母、数字、小数点（.）、斜线（/）、中划线（-）、下划线（_）、加号（+）、井号（#）、等号这些字符。

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

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