接口说明
对指定id的云手机执行恢复数据操作。即用户从其在移动云平台上订购的对象存储桶中选择“导出云手机数据”接口或者控制台备份的tar文件,将其下载并解压到云手机目录下。需要云手机重启后才能恢复数据。 注意: 1. 本接口属于异步任务接口,返回结果只有任务id。查询该任务的执行状态需要客户配置回调信息,或者根据任务id调用“查询任务执行状态详情/列表”接口来实现; 2. 对象存储桶和指定id的云手机必须在同一个资源池中; 3. 使用本接口前必须在云手机控制台-对象存储管理中绑定对象存储信息; 4. 任务的时长取决于恢复数据的大小; 5. 云手机重启后,数据才能恢复;
URL
POST https://ecloud.10086.cn/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/phones/restore
请求参数
Body
|
参数名称
|
类型
|
必填
|
描述
|
|
req
|
OpenapiCloudPhoneRestoreReq
|
是
|
req |
|
callbackUrl
|
string
|
否
|
回调url,如http://192.168.0.1:5556/api/callback,needCallback为true才能生效 |
|
needAuth
|
boolean
|
否
|
是否需要鉴权 |
|
needCallback
|
boolean
|
否
|
是否需要回调 |
|
storageInfos
|
<RestoreInfos> array
|
是
|
数据备份实体 |
|
bucketName
|
string
|
是
|
导出数据存储的对象存储桶名。 合法的对象存储桶名,3-63个字符,只能由小写字母、数字、中划线(-)和小数点(.)组成。 |
|
id
|
string
|
是
|
云手机实例id |
|
objectPath
|
string
|
是
|
导出数据存储的对象存储路径名。 符合对象存储的路径名规范,最大长度1024字符。目前只支持大小写字母、数字、小数点(.)、斜线(/)、中划线(-)、下划线(_)、加号(+)、井号(#)、等号这些字符。 |
请求示例
POST https://ecloud.10086.cn/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/phones/restore
{
"storageInfos":[
{
"bucketName":"cloudphone-app",
"id":"1899352770273898497",
"objectPath":"/aa/cloudphonebackup01.tar"
}
],
"needCallback":true,
"callbackUrl":"http://192.168.0.1:5556/api/callback",
"needAuth":true
}
返回参数
|
参数名称
|
类型
|
描述
|
|
body
|
<OpenapiCloudPhoneJobResultDto> array
|
响应体 |
|
errorCode
|
string
|
任务错误码 |
|
errorMsg
|
string
|
任务错误码说明 |
|
id
|
string
|
云手机ID |
|
jobId
|
string
|
任务ID |
|
errorCode
|
string
|
错误编码 |
|
errorMessage
|
string
|
错误信息 |
|
requestId
|
string
|
请求id |
|
state
|
string
|
状态值 |
返回示例
{
"errorCode":"00000000",
"errorMessage":"请求成功",
"requestId":"128a4b11-6f2c-40b7-8126-47e90587e23a",
"state":"OK",
"body":[
{
"id":"1899352770273898497",
"jobId":"1900097190237749250",
"errorCode":null,
"errorMsg":null
}
]
}