文档首页/ 云手机服务器 CPH/ API参考/ 云手机服务器API/ 手机实例管理/ 导出云手机数据
更新时间：2024-12-05 GMT+08:00
在线调试
CLI示例
查看PDF
分享

导出云手机数据

功能介绍

批量导出云手机中的数据。该接口为异步接口。接口调用前请先确保已完成CPH服务操作OBS桶的委托授权。委托CPH操作OBS桶请参见委托CPH操作OBS桶。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v1/{project_id}/cloud-phone/phones/batch-storage

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目id。

请求参数

表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字符。目前只支持大小写字母、数字、小数点（.）、斜线（/）、中划线（-）、下划线（_）、加号（+）、井号（#）、等号这些字符。

响应参数

状态码： 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-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

OK

{
  "request_id" : "6837531fd3f54550927b930180a706bf",
  "jobs" : [ {
    "phone_id" : "1234567b8bab40ffb711234cb80d0234",
    "job_id" : "1564567b8bab40f34711234cb80d0123"
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 手机实例管理

相关文档