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

使用说明

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

注意事项

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

请求说明

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

请求参数

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

Query

Body

返回参数

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

BackupDataDetail

请求示例

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

返回示例

{
    "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******"
            }
        ]
    }
}

错误码

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