DescribeBackupFiles - 查询备份文件列表 - 无影云手机

调用DescribeBackupFiles接口查询备份文件列表。

接口说明

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

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
BackupFileId	string	否	备份文件 ID。	bf-dxrh5jrv0zpb8****
BackupFileName	string	否	备份文件名称模糊查询。	测试
InstanceGroupId	string	否	实例组 ID。	ag-fxdx91jsfyiy3****
AndroidInstanceId	string	否	实例 ID。	acp-34pqe4r0kd9kn****
AndroidInstanceName	string	否	实例名称模糊查询。	acp-34pqe4r0kd9kn****
Description	string	否	描述模糊查询。	测试
StartTime	string	否	查询当前时间之后的备份文件。	2024-05-23 10:00:00
EndTime	string	否	查询当前时间之前的备份文件。	2024-05-20 10:00:00
EndUserId	string	否	备份文件的 Owner。	test1
MaxResults	long	否	分页查询时每页的最大条目数。取值范围 1～100，默认值为 10。	10
NextToken	string	否	用来表示当前开始读取的位置。置空表示从头开始。	AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****

返回参数

名称	类型	描述	示例值
	object	返回参数。
Data	array<object>	返回结果对象列表。
BackupFileInfoModel	object	返回结果对象。
GmtCreated	string	创建时间。	2024-05-15 17:33:59
GmtModified	string	更新时间	2024-05-15 17:33:59
BackupFileId	string	备份文件 ID。	bf-b0qbg3pbpjkn7****
BackupFileName	string	备份文件名称。	a-58ftsoo90p0qa****.ab
InstanceGroupId	string	实例 ID。	ag-58ftsoo90p0qi****
AndroidInstanceId	string	实例 ID。	acp-34pqe4r0kd9kn****
AndroidInstanceName	string	实例名称。	测试云手机
EndUserId	string	备份文件的 Owner。	test
Status	string	备份文件状态。枚举值： AVAILABLE：可用。 RECOVERING：恢复中。	AVAILABLE
SourceFilePathList	array	源备份文件的目录列表。
sourceFilePath	string	源备份文件的目录。	/data/media
FileSize	long	源备份文件总大小。	10227168
UploadType	string	备份类型。枚举值： OSS：备份文件保存在OSS桶。。	OSS
UploadEndpoint	string	上传地址的域名。	oss-cn-hangzhou.aliyuncs.com
BackupFilePath	string	备份文件保存的目录。	oss://cloudphone-saved-bucket-cn-shanghai/backup/aic-58ftsoo90p0qa****.ab
Description	string	备份文件的描述信息。	这是备份/data/media目录的备份文件。
RequestId	string	请求唯一 ID，如果遇到问题请提供这个请求 ID，由工作人员为您排查。	425F351C-3F8E-5218-A520-B6311D0D****
NextToken	string	用来表示当前调用返回读取到的位置。空代表数据已经读取完毕。	AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****
MaxResults	string	本次读取的最大数据量。	10
TotalCount	long	总条目数。	91

示例

正常返回示例

JSON格式

{
  "Data": [
    {
      "GmtCreated": "2024-05-15 17:33:59",
      "GmtModified": "2024-05-15 17:33:59",
      "BackupFileId": "bf-b0qbg3pbpjkn7****",
      "BackupFileName": "a-58ftsoo90p0qa****.ab",
      "InstanceGroupId": "ag-58ftsoo90p0qi****",
      "AndroidInstanceId": "acp-34pqe4r0kd9kn****",
      "AndroidInstanceName": "测试云手机",
      "TaskId": "",
      "EndUserId": "test",
      "Status": "AVAILABLE",
      "SourceFilePathList": [
        "/data/media"
      ],
      "SourceAppInfoList": [
        ""
      ],
      "RegionId": "",
      "FileSize": 10227168,
      "UploadType": "OSS",
      "UploadEndpoint": "oss-cn-hangzhou.aliyuncs.com",
      "BackupFilePath": "oss://cloudphone-saved-bucket-cn-shanghai/backup/aic-58ftsoo90p0qa****.ab",
      "Description": "这是备份/data/media目录的备份文件。",
      "BackupAll": true
    }
  ],
  "RequestId": "425F351C-3F8E-5218-A520-B6311D0D****",
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****",
  "MaxResults": "10",
  "TotalCount": 91
}

错误码

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

变更历史

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