调用 RestoreColdArchiveVideo 接口恢复指定 Vid(视频 ID)对应的冷归档文件。
冷归档存储为白名单功能,当前仅支持已挂载火山引擎对象存储 TOS Bucket 的存储场景。使用前请提交工单联系火山引擎技术支持团队申请开通。
文件恢复完成后,在 Days 指定的有效期内可直接读取;有效期结束后,文件恢复为不可直接读取的冷归档状态。
请求地址:https://vod.volcengineapi.com?Action=RestoreColdArchiveVideo&Version=2023-07-01
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | RestoreColdArchiveVideo | 接口名称。当前 API 的名称为 RestoreColdArchiveVideo。 |
Version | String | 是 | 2023-07-01 | 接口版本。当前 API 的版本为 2023-07-01。 |
SpaceName | String | 是 | test | 空间名称。 |
Vids | String | 是 | v02c24g1000***1v0q66n3sip0 | 视频 ID 列表。多个 Vid 用英文逗号分隔,最多支持 20 个。 |
FileIds | String | 否 | v02c24g10***1v0q66n3sip0 | 媒体处理输出文件 ID 列表。多个 FileId 用英文逗号分隔,最多支持 20 个。传入 FileIds 时,Vids 仅支持填写一个 Vid。 |
RestoreTier | String | 否 | Expedited | 恢复优先级。取值如下:
|
Days | String | 否 | 1 | 文件保持可读取状态的天数。取值范围为 1~365,默认为 1 天。 |
下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
NotExistVids | String[] | ["v02c24g1000***1v0q66n3sip0"] | 不存在的 Vid 列表。 |
https://vod.volcengineapi.com?Action=RestoreColdArchiveVideo&Version=2023-07-01&SpaceName=test&Vids=v02c24g1000***1v0q66n3sip0&FileIds=v02c24g10***1v0q66n3sip0&RestoreTier=Expedited&Days=1 { "SpaceName": "test", "Vids": "v02c24g1000***1v0q66n3sip0", "FileIds": "v02c24g10***1v0q66n3sip0", "RestoreTier": "Expedited", "Days": "1" }
{ "Result": { "NotExistVids": [ "v02c24g1000***1v0q66n3sip0" ] }, "ResponseMetadata": { "Action": "RestoreColdArchiveVideo", "Region": "cn-north-1", "Service": "vod", "Version": "2023-07-01", "RequestId": "20230604110420****100232280022D31" } }
本接口无特有的错误码。更多信息请见公共错误码。