查询备份数据 ListBackupData--云手机-火山引擎

文档中心

立即注册

导航

查询备份数据 ListBackupData

最近更新时间：2025.11.07 18:04:15首次发布时间：2025.09.26 11:09:04

查询指定业务下备份数据的详细信息，包括备份数据ID、状态、大小、源实例、当前使用次数以及总恢复次数等信息。

注意事项

本接口的单用户 QPS 限制为 30 次/秒。超过限制，API 调用会被限流。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=ListBackupData&Version=2025-05-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListBackupData`	接口名称。当前 API 的名称为 `ListBackupData`。
Version	String	是	`2025-05-01`	接口版本。当前 API 的版本为 `2025-05-01`。

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`163571455047****`	业务 ID，用于指定想要备份数据的实例所在业务。可登录云手机控制台，在已创建的业务卡片中获取。
SourcePodId	String	否	`7294157141458******`	备份数据的源实例 ID。
BackupDataIdList	Array of String	否	`["7294157141458****", "7294157141459****"]`	备份数据 ID 列表。
Status	String	否	`completed`	备份数据状态。可选值： pending：待处理 running：备份中 completed：备份完成，可用于恢复数据 failed：备份失败 deleting：删除中
MaxResults	Integer	否	`10`	分页查询时设置的每页行数。最大值：100 默认值：10
NextToken	String	否	`AABCToken******`	分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次 API 调用返回的 NextToken 参数值。NextToken 无效会从第一条记录开始返回，不会产生错误。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
NextToken	String	`AABCToken******`	分页查询时，返回的下一页的 Token。
Rows	Array of PodBackupData	`-`	数据备份的详细信息。

PodBackupData

参数	类型	示例值	描述
Detail	String	`Backup Task finished`	备份数据详细描述。
Md5Sum	String	`e10adc3949******`	备份数据的 MD5 值。
Status	String	`completed`	备份数据状态。可选值： pending：待处理 running：备份中 completed：备份完成，可用于恢复数据 failed：备份失败 deleting：删除中
DataSize	Long	`69092905424`	备份数据大小。
AccountId	String	`2100******`	火山引擎账号 ID。
ProductId	String	`1968301******`	业务 ID。
BackupSize	Long	`69092905424`	备份数据最终保存大小。
BackupType	String	`Full`	备份数据的备份类型。目前仅支持 `Full` 整机备份。
ExpireTime	Long	`0`	备份数据的过期时间。
InUseCount	Long	`1`	备份数据的当前引用次数。
AOSPVersion	String	`13`	备份数据源实例的 AOSP 版本。
BackupJobId	String	`job-7294170061873****-7294157141458****`	备份子任务 ID。
CreatedTime	Long	`1758009530`	备份数据信息的创建时间。时间戳格式，单位：秒。
Description	String	`demo`	备份数据描述。
SourcePodId	String	`7294157141458******`	备份数据的源实例 ID。
StartedTime	Long	`1758009536`	备份数据的开始时间。时间戳格式，单位：秒。
StorageType	String	`ceph`	备份数据的存储类型。
UpdatedTime	Long	`1758012305`	备份数据信息的更新时间。时间戳格式，单位：秒。
BackupDataId	String	`7662481234******`	备份数据 ID。
BackupTaskId	String	`7400702264829******`	备份任务 ID。
RestoreCount	Long	`1`	备份数据的恢复总次数。
CompletedTime	Long	`1758011707`	备份数据的完成时间。时间戳格式，单位：秒。
BackupDataName	String	`7662481234******`	备份数据名称/别名。
CompressionType	String	`zstd`	备份数据的压缩类型。
StorageResource	String	`{"FsType": "ext4", "VolumeID": "rbd-******"}`	备份数据的存储资源，不同存储类型资源内容不同

请求示例

POST https://open.volcengineapi.com?Action=ListBackupData&Version=2025-05-01
{
    "ProductId": "163571455047****",
    "SourcePodId": "7294157141458******",
    "BackupDataIdList": [
        "7294157141458******",
        "7294157141459******"
    ],
    "Status": "completed",
    "MaxResults": 10,
    "NextToken": "AABCToken******"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "ListBackupData",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2025-05-01",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "NextToken": "AABCToken******",
        "Rows": [
            {
                "Detail": "Backup Task finished",
                "Md5Sum": "e10adc3949******",
                "Status": "completed",
                "DataSize": 69092905424,
                "AccountId": "2100******",
                "ProductId": "1968301******",
                "BackupSize": 69092905424,
                "BackupType": "Full",
                "ExpireTime": 0,
                "InUseCount": 1,
                "AOSPVersion": "13",
                "BackupJobId": "job-7294170061873******-7294157141458******",
                "CreatedTime": 1758009530,
                "Description": "demo",
                "SourcePodId": "7294157141458******",
                "StartedTime": 1758009536,
                "StorageType": "ceph",
                "UpdatedTime": 1758012305,
                "BackupDataId": "7662481234******",
                "BackupTaskId": "7400702264829******",
                "RestoreCount": 1,
                "CompletedTime": 1758011707,
                "BackupDataName": "7662481234******",
                "CompressionType": "zstd",
                "StorageResource": "{\"FsType\": \"ext4\", \"VolumeID\": \"rbd-******\"}"
            },
            {
                "Detail": "Backup Task finished",
                "Md5Sum": "e123adc3949******",
                "Status": "completed",
                "DataSize": 69092905424,
                "AccountId": "2100******",
                "ProductId": "1968302******",
                "BackupSize": 69092905424,
                "BackupType": "Full",
                "ExpireTime": 0,
                "InUseCount": 1,
                "AOSPVersion": "13",
                "BackupJobId": "job-7294170061872******-7294157141457******",
                "CreatedTime": 1758009530,
                "Description": "demo",
                "SourcePodId": "7294157141459******",
                "StartedTime": 1758009536,
                "StorageType": "ceph",
                "UpdatedTime": 1758012305,
                "BackupDataId": "7662481233******",
                "BackupTaskId": "7400702264828******",
                "RestoreCount": 1,
                "CompletedTime": 1758011707,
                "BackupDataName": "7662481233******",
                "CompressionType": "zstd",
                "StorageResource": "{\"FsType\": \"ext4\", \"VolumeID\": \"rbd-******\"}"
            }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。