取消备份实例 CancelBackupPod--云手机-火山引擎

文档中心

立即注册

导航

云手机

取消备份实例 CancelBackupPod

最近更新时间：2025.07.02 18:14:22首次发布时间：2025.07.01 16:02:28

本地存储业务取消备份指定云手机实例的数据至云盘。
调用 BackupPod 接口发起实例备份请求后，可使用本接口取消备份。

注意事项

仅支持取消“备份排队中”的实例备份，已完成备份或正在备份中的实例不支持取消操作。
单次接口调用支持取消备份的实例数量上限为 100。
本接口的单用户 QPS 限制为 5 次/秒。超过限制，API 调用会被限流。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1635714550******`	取消备份的实例所归属的业务 ID。
PodIdList	Array of String	是	`[7294157141458****, 7294157141458****]`	取消备份的实例 ID 列表。注意仅支持取消“备份排队中”状态（即 `ArchiveStatus` 为 5）的实例备份，已完成备份或正在备份中的实例不支持取消操作。可调用 `ListPod` 接口，获取指定实例当前的 `ArchiveStatus` 值。单次接口调用支持取消备份的实例数量上限为 100。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST https://open.volcengineapi.com?Action=CancelBackupPod&Version=2025-05-01
{
    "ProductId": "1635714550******",
    "PodIdList": [
        "7294157141458******",
        "7294157141458******"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "Action": "CancelBackupPod",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2025-05-01",
        "RequestId": "20230604110420****100232280022D31"
    }
}

错误码

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