BackupFile - 创建备份文件

生成并上传备份文件。

接口说明

目前仅支持云手机生成的备份文件保存在 OSS 对象存储服务。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
AndroidInstanceIdListarray

实例 ID 列表。

string

实例 ID。

aic-ig2bdpk374l12****
Descriptionstring

备份文件描述。

这是一个备份/data的请求。
SourceFilePathListarray

备份的文件路径列表。

string

Android 系统的源文件目录绝对路径。

/data
SourceAppListarray

备份的应用包名列表。

string

备份的应用包名。

com.example.xhs
UploadTypestring

备份类型。

枚举值:
  • OSS备份文件上传到OSS桶。
OSS
UploadEndpointstring

备份地址的域名。

注意 如果上传到 OSS 桶,调用 describeBuckets 接口获取 Bucket,如果云手机和 bucket 是同地域,获取 intranetEndpoint 字段;如果是不同地域获取 extranetEndpoint 字段。

oss-cn-shanghai-internal.aliyuncs.com
BackupFilePathstring

备份文件的上传地址。

注意 如果上传到 OSS 桶,调用 describeBuckets 接口获取 bucketName,选择 ossObjectList 获取 key,拼接成“oss://${bucketName}/${key}”

oss://cloudphone-saved-bucket-****/mabo/aic-i3b83gk0rw6p24jx3_2024051409****.ab
BackupFileNamestring

备份文件名称。

MyBackup
BackupAllboolean

是否整机备份。

false

返回参数

名称类型描述示例值
object

返回参数。

Dataarray<object>

返回结果对象。

6C8439B9-7DBF-57F4-92AE-55A9B9D3****
BackupFileTaskListobject
BackupFileIdstring

备份文件 ID。

bf-b0qbg3pbpjkn7****
BackupFileNamestring

备份文件名称。

MyBackup
AndroidInstanceIdstring

云手机实例 ID。

acp-34pqe4r0kd9kn****
TaskIdstring

任务 ID。

t-22ex666a653gq****
RequestIdstring

请求 ID。

6C8439B9-7DBF-57F4-92AE-55A9B9D3****
Countlong

备份的实例个数。

1
TaskIdstring

批量任务 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****"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-11-14OpenAPI 入参发生变更查看变更详情
2024-10-16OpenAPI 描述信息更新、OpenAPI 返回结构发生变更查看变更详情