备份数据 BackupData--云手机-火山引擎

文档中心

立即注册

云手机

数据备份与恢复

备份数据 BackupData

指定一个或多个实例进行数据备份。对于单个实例，最终生成一份备份数据保存在同机房的云存储上，可以用来恢复至源实例，也可以复制到其他实例。

使用说明

目前生成的备份文件仅支持保存在同机房的云存储上，请确保订购资源时订购了按量计费的存储空间，以容纳备份数据。
本接口为异步接口，调用成功仅表示任务已提交。您可以通过以下任意途径，获取任务最终执行结果：
- 配置“任务执行回调”和“子任务执行回调”，具体操作请参考云手机回调服务接入指南；
- 根据生成的任务 ID，调用 GetTaskInfo 接口查询任务执行结果；
- 通过控制台任务管理页面查询。
该接口是将指定实例内的数据打包备份，BackupPod 是将指定实例迁移备份。两者区别请参见备份实例 BackupPod 和备份数据 BackupData 的区别。

注意事项

本接口仅支持本地存储业务的实例。
为避免备份失败，如果实例内已使用的存储空间超过 95%，则不支持备份。
执行数据备份时，如果实例处于开机状态，会自动关机，再执行备份操作，备份完成之后自动开机。
数据备份期间，不允许对实例进行其他操作，包括开机、关机、重启、更新以及删除等。
数据备份期间，请勿对云机执行重置、更新、重启、或退订等其他操作，否则有可能导致备份失败或实例数据损坏。
本接口的单用户 QPS 限制为 5 次/秒。超过限制，API 调用会被限流。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	163571455047****	业务 ID，用于指定想要备份数据的实例所在业务。可登录云手机控制台，在已创建的业务卡片中获取。
PodIdList	Array of String	是	["7294157141457****", "7294157141458****"]	实例 ID 列表，用于指定想要备份数据的源实例 ID 列表。最大长度为100。
Description	String	否	backup all files	备份数据描述。最大长度为128个字符。
BackupAll	Boolean	否	false	是否备份所有文件（即整机全量备份），默认为 false。取值为 true 时，无需设置 IncludePathList、ExcludePathList 参数。取值为 false 时，需要设置 IncludePathList、ExcludePathList 参数。注意如果当前参数取值为 false 且 IncludePathList、ExcludePathList 参数均未设置，则调用接口时按整机全量备份处理。非整机全量备份时，不建议对系统类文件进行备份，在恢复时可能会因为兼容性等问题导致系统崩溃。
IncludePathList	Array of String	否	["/data/app", "/data/data"]	包含路径列表，对该列表内的路径进行数据备份，必须以 `/data/` 开头。如果 BackupAll 取值为 true，则该参数无效。列表最大长度为 10，多个路径之间使用半角逗号（`,`）分隔。单个路径最大长度为 256 个字符。在路径中支持 `` 匹配符，用于匹配当前路径层级中的任意字符。例如：`/data/app` 可以匹配到 `/data/app1`、`/data/app2` 等路径。
ExcludePathList	Array of String	否	["/data/anr", "/data/system"]	排除路径列表，被排除的路径不会进行数据备份，必须以 `/data/` 开头。如果 BackupAll 为 true，则该参数无效。列表最大长度为 10，多个路径之间使用半角逗号（`,`）分隔。单个路径最大长度为 256 个字符。在路径中支持 `` 匹配符，用于匹配当前路径层级中的任意字符。例如：`/data/app` 可以匹配到 `/data/app1`、`/data/app2` 等路径。

返回参数

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

参数	类型	示例值	描述
TaskIdList	Array of String	["7400702264828****", "7400702264829****"]	备份数据任务 ID 列表，如果请求实例列表来自多个区域，则会返回多个任务ID。
Details	Array of BackupDataDetail	-	备份任务详情列表。

BackupDataDetail

参数	类型	示例值	描述
JobId	String	job-7294170061873****-7294157141458****	备份数据的子任务 ID。
PodId	String	7294157141458******	备份数据的源实例 ID。
TaskId	String	7400702264829******	备份数据的任务 ID。
BackupDataId	String	7662481234******	备份数据 ID。

请求示例

POST https://open.volcengineapi.com?Action=BackupData&Version=2025-05-01
{
    "ProductId": "163571455047****",
    "PodIdList": [
        "7294157141457******",
        "7294157141458******"
    ],
    "Description": "backup all files",
    "BackupAll": false,
    "IncludePathList": [
        "/data/app",
        "/data/data"
    ],
    "ExcludePathList": [
        "/data/anr",
        "/data/system"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "Action": "BackupData",        
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2025-05-01",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "TaskIdList": [
            "7400702264828******",
            "7400702264829******"
        ],
        "Details": [
            {
                "JobId": "job-7294170061872******-7294157141457******",
                "PodId": "7294157141457******",
                "TaskId": "7400702264828******",
                "BackupDataId": "7662481233******"
            },
            {
                "JobId": "job-7294170061873******-7294157141458******",
                "PodId": "7294157141458******",
                "TaskId": "7400702264829******",
                "BackupDataId": "7662481234******"
            }
        ]
    }
}

错误码

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

最近更新时间：2026.01.19 10:20:35

这个页面对您有帮助吗？

有用

无用

云手机

使用说明 #

注意事项 #

请求说明 #

请求参数 #

Query #

Body #

返回参数 #

BackupDataDetail #

请求示例 #

返回示例 #

错误码 #