调用 GetRestoreVideoStatus 接口查询指定 Vid（视频 ID）对应冷归档文件的恢复状态。

使用说明 #

冷归档存储为白名单功能，当前仅支持已挂载火山引擎对象存储 TOS Bucket 的存储场景。使用前请提交工单联系火山引擎技术支持团队申请开通。
传入 FileId 时，接口返回该文件的恢复状态；不传 FileId 时，接口返回 Vid 下所有文件的聚合恢复状态。Vid 下所有文件均恢复为可读取状态后，才表示该 Vid 恢复完成。

注意事项 #

• Vid 和 FileId 均只支持填写一个。
• HLS、DASH 文件包含索引文件和分片文件。恢复时系统会先恢复索引文件，再恢复分片文件，因此恢复耗时通常长于单文件。
• State 为 Partial 时，表示 Vid 下仅部分文件可以读取，请继续查询直至所有所需文件均恢复完成。

请求说明 #

请求地址：https://vod.volcengineapi.com?Action=GetRestoreVideoStatus&Version=2023-07-01

请求参数 #

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

返回参数 #

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

请求示例 #

https://vod.volcengineapi.com?Action=GetRestoreVideoStatus&Version=2023-07-01&SpaceName=test&Vid=v02c24g1000***1v0q66n3sip0&FileId=v02c24g10***1v0q66n3sip0
{
  "SpaceName": "test",
  "Vid": "v02c24g1000***1v0q66n3sip0",
  "FileId": "v02c24g10***1v0q66n3sip0"
}

返回示例 #

{
  "Result": {
    "State": "Restoring"
  },
  "ResponseMetadata": {
    "Action": "GetRestoreVideoStatus",
    "Region": "cn-north-1",
    "Service": "vod",
    "Version": "2023-07-01",
    "RequestId": "20230604110420****100232280022D31"
  }
}

错误码 #

本接口无特有的错误码。更多信息请见公共错误码。