华为云用户手册

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

响应参数 状态码： 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 表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字符。 不能为空，可以包含任意语种字母、数字、空格和_.：=+-@，但首尾不能含有空格。

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

请求参数 表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的参数值为资源名称。

请求示例 切换云手机服务器 POST https://{CPH Endpoint}/v2/{project_id}/cloud-phone/servers/{server_id}/change { "phone_model_name" : "kg1.cp.c20.d64SSD.e1v1", "image_id" : "20060220200717f201120a2300000e91", "keypair_name" : "keypair", "ports" : [ { "name" : "myServer1", "listen_port" : 20000, "internet_accessible" : "false" }, { "name" : "myServer2", "listen_port" : 20001, "internet_accessible" : "true" } ], "extend_param" : { "enterprise_project_id" : "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 } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 phone_model_name 是 String 云手机规格，不超过64个字节。 image_id 是 String 云手机镜像ID，不超过32个字节。 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 云手机使用的带宽信息。 表4 Port 参数 是否必选 参数类型 描述 name 是 String 应用端口名称，不超过16个字节，系统关键服务名称不能使用"adb"和"vnc"。 listen_port 是 Integer 端口号，大于等于10000，小于等于50000。 internet_accessible 是 String 为"true"则映射出公网访问（忽略大小写）。 为其他则不映射。 表5 extend_param 参数 是否必选 参数类型 描述 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，共享带宽

请求参数 表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 错误说明。

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

请求示例 将数据从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" } ] }

请求参数 表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" } ] }

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

请求参数 表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 错误说明。

请求示例 批量删除标签 Post https://{CPH Endpoint}/v1/{project_id}/{resource_type}/{resource_id}/tags { "action" : "delete", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 操作标识。 delete：刪除 tags 是 Array of Tag objects 标签列表。 表4 Tag 参数 是否必选 参数类型 描述 key 是 String 键。 最大长度127个unicode字符。 不能为空，可以包含任意语种字母、数字、空格和_.：=+-@，不能以_sys_开头。 value 是 String 值列表。 每个值最大长度255个unicode字符。 不能为空，可以包含任意语种字母、数字、空格和_.：=+-@，但首尾不能含有空格。