生成备份文件并上传到远端存储。 使用场景:可以基于数据安全的角度进行定期备份,也可以备份一机文件,恢复到多机,实现类似复制迁移的效果。
接口说明
目前仅支持云手机生成的备份文件保存在 OSS 对象存储服务。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| AndroidInstanceIdList |
array |
是 |
实例 ID 列表。 |
|
|
string |
否 |
实例 ID。 |
aic-ig2bdpk374l12**** |
|
| Description |
string |
否 |
备份文件描述。 |
这是一个备份/data的请求。 |
| SourceFilePathList |
array |
否 |
备份的文件路径列表。 |
|
|
string |
否 |
Android 系统的源文件目录绝对路径。 |
/data |
|
| SourceAppList |
array |
否 |
备份的应用包名列表。 |
|
|
string |
否 |
备份的应用包名。 |
com.example.xhs |
|
| UploadType |
string |
否 |
备份类型。 枚举值:
|
OSS |
| UploadEndpoint |
string |
否 |
备份地址的域名。 说明
如果上传到 OSS Bucket,调用 describeBuckets 接口获取 Bucket,如果云手机和 Bucket 是同地域,获取 intranetEndpoint 字段;如果是不同地域获取 extranetEndpoint 字段。 |
oss-cn-shanghai-internal.aliyuncs.com |
| BackupFilePath |
string |
是 |
备份文件的上传地址。 说明
如果上传到 OSS Bucket,调用 describeBuckets 接口获取 bucketName,选择 ossObjectList 获取 key,key 是 OSS Bucket 的文件夹路径,拼接成 |
oss://cloudphone-saved-bucket-****/backupDir/ |
| BackupFileName |
string |
否 |
备份文件名称。 |
MyBackup |
| BackupAll |
boolean |
否 |
是否整机备份。 |
false |
| ExcludeSourceFilePathList |
array |
否 |
||
|
string |
否 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回参数。 |
||
| Data |
array<object> |
返回结果对象。 |
6C8439B9-7DBF-57F4-92AE-55A9B9D3**** |
|
object |
|||
| BackupFileId |
string |
备份文件 ID。 |
bf-b0qbg3pbpjkn7**** |
| BackupFileName |
string |
备份文件名称。 |
MyBackup |
| AndroidInstanceId |
string |
云手机实例 ID。 |
acp-34pqe4r0kd9kn**** |
| TaskId |
string |
任务 ID。 |
t-22ex666a653gq**** |
| RequestId |
string |
请求 ID。 |
6C8439B9-7DBF-57F4-92AE-55A9B9D3**** |
| Count |
integer |
备份的实例个数。 |
1 |
| TaskId |
string |
批量任务 ID。 |
t-14xwibw7pyrjd**** |
示例
正常返回示例
JSON格式
{
"Data": [
{
"BackupFileId": "bf-b0qbg3pbpjkn7****",
"BackupFileName": "MyBackup",
"AndroidInstanceId": "acp-34pqe4r0kd9kn****",
"TaskId": "t-22ex666a653gq****"
}
],
"RequestId": "6C8439B9-7DBF-57F4-92AE-55A9B9D3****",
"Count": 1,
"TaskId": "t-14xwibw7pyrjd****"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。