导出云手机数据

接口说明

对指定id的云手机执行导出数据操作。即用户将云手机内指定目录内的文件压缩成tar文件并上传至移动云平台上订购的对象存储桶内。 注意: 1. 本接口属于异步任务接口,返回结果只有任务id。查询该任务的执行状态需要客户配置回调信息,或者根据任务id调用“查询任务执行状态详情/列表”接口来实现; 2. 对象存储桶和指定id的云手机必须在同一个资源池中; 3. 使用本接口前必须在云手机控制台-对象存储管理中绑定对象存储信息; 4. 任务的时长取决于导出数据的大小;


推荐使用API Explorer调试

API Explorer支持接口在线可视化调用,同时自动生成动态代码示例,搭配OpenAPI SDK无需计算签名实现接口快速集成。

URL

POST https://ecloud.10086.cn/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/phones/storage

请求参数

Body

参数名称
类型
必填
描述
req
OpenapiCloudPhoneExportStorageReq
是

req

callbackUrl
string
否

回调url,如http://192.168.0.1:5556/api/callback,needCallback为true才能生效

needAuth
boolean
否

是否需要鉴权

needCallback
boolean
否

是否需要回调

storageInfos
<StorageInfos> array
是

数据导出实体

bucketName
string
是

导出数据存储的对象存储桶名。 合法的对象存储桶名,3-63个字符,只能由小写字母、数字、中划线(-)和小数点(.)组成。

excludeFiles
<string> array
否

不能导出数据的存储路径。exclude_files优先级比include_files高,如果冲突,exclude_files生效。 路径要求同include_files。

id
string
是

云手机实例id

includeFiles
<string> array
否

需要导出数据的存储路径,绝对路径,最大长度4096字节。仅支持导出/data和、cache目录下的数据。目前只支持大小写字母、数字、小数点(.)、斜线(/)、中划线(-)、下划线(_)、加号(+)、井号(#)、星号(*)、等号这些字符。

objectPath
string
是

导出数据存储的对象存储路径名。 符合对象存储的路径名规范,最大长度1024字符。目前只支持大小写字母、数字、小数点(.)、斜线(/)、中划线(-)、下划线(_)、加号(+)、井号(#)、等号这些字符。

请求示例

POST https://ecloud.10086.cn/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/phones/storage
{
	"storageInfos":[
		{
			"bucketName":"cloudphone-app",
			"id":"1899352770273898497",
			"includeFiles":[
				"/data/app",
				"/data/data",
				"/data/media",
				"/data/user",
				"/data/system/users/0/appwidgets.xml",
				"/data/system/packages.list",
				"/data/system/packages.xml",
				"/data/system/byteos"
			],
			"excludeFiles":[
				"/data/system/users/0/settings_secure.xml"
			],
			"objectPath":"/aa/cloudphonebackup01.tar"
		}
	],
	"needCallback":true,
	"callbackUrl":"http://192.168.0.1:5556/api/callback",
	"needAuth":true
}

返回参数

返回码:200
OK
参数名称
类型
描述
body
<OpenapiCloudPhoneJobResultDto> array

响应体

errorCode
string

任务错误码

errorMsg
string

任务错误码说明

id
string

云手机ID

jobId
string

任务ID

errorCode
string

错误编码

errorMessage
string

错误信息

requestId
string

请求id

state
string

状态值

返回示例

返回码:200
OK
{
	"errorCode":"00000000",
	"errorMessage":"请求成功",
	"requestId":"b58ab2f8-a993-4e9c-85ac-04b1bf0562ff",
	"state":"OK",
	"body":[
		{
			"id":"1899352770273898497",
			"jobId":"1900096726351921153",
			"errorCode":null,
			"errorMsg":null
		}
	]
}
本文档内容整理自移动云官方帮助中心(查看原文),仅供参考。