提交媒资封禁或解禁任务--视频点播-火山引擎

文档中心

立即注册

导航

提交媒资封禁或解禁任务

最近更新时间：2024.08.13 20:53:17首次发布时间：2024.07.19 17:11:47

此接口用于指定 FileName 提交媒资封禁或解封任务。

使用说明

媒资被封禁后，终端用户对该媒资 URL 的访问将被源站拒绝，返回 "The object access is banned" 错误。
封禁仅影响通过在视频点播空间内配置的域名访问对应的资源，资源本身的转码、存储策略等功能不会受到影响。

注意事项

请求频率：单用户请求频率限制为 20 次/秒。

请求说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	`SubmitBlockObjectTasks`	接口名称。当前 API 的名称为 `SubmitBlockObjectTasks`。
Version	String	是	`2023-07-01`	接口版本。当前 API 的版本为 `2023-07-01`。
SpaceName	String	是	`vod_test`	点播空间名称。可通过以下方式获取空间名称：在视频点播控制台空间管理页面查看当前账号下所有空间的名称。调用 ListSpace 接口获取当前账号下所有空间的名称。
Operation	String	是	`forbid`	操作类型。取值如下： `forbid`：封禁任务 `recover`：解封任务
FileNamesUrlEncoded	String	是	`forbid`	URL 编码后的文件路径。多个文件路径用英文逗号 `,` 连接，一次最多传入 20 个。您可在视频点播控制台视频管理页面获取文件路径。说明为了防止特殊字符比如逗号出现在 `FileName` 中，您需要将文件路径进行 URL 编码。对于含有保留字符（`$`, `&`, `+`, `,`, `/`, `:`, `;`, `=`, `?`, `@`）的 `FileName`，除了安全的字符（`@`、`&`、`=`、`+`、`$`）需要保留外，其余字符必须依据 RFC3986 协议进行 URLEncode。假设 `FileName` 为 `abc/ /!/*/'/(/;/:/@/&/=/+/$/,/?/#/[/1.mp4`，经过 URL 编码后为 `abc%2F%20%2F%21%2F%2A%2F%27%2F%28%2F%3B%2F:%2F@%2F&%2F=%2F+%2F$%2F%2C%2F%3F%2F%23%2F%5B%2F1.mp4` 。您必须传入 `FileNameEncodeds` 才看到返回数据。
RefreshCdn	String	否	`enable`	是否刷新缓存。取值如下： `enable`：（默认）刷新缓存 `disable`：不刷新缓存注意仅当 `Operation` 为 `forbid` 时生效。单个账号每日最多可刷新 1000 个 URL。此接口与 CreateCdnRefreshTask 共用配额。

返回参数

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

参数	类型	示例值	描述
Operation	String	`forbid`	操作类型。取值如下： `forbid`：封禁任务 `recover`：解封任务
OperateFileNames	Object	`-`	操作类型对应的文件路径。
FailedFileNames	Object[]	`-`	失败的任务列表。
TaskId	String	`6683adbab8cac7d04*****cce`	任务 ID。
Message	String	`-`	信息。
FileName	String	`1eb8debe45e4*****5822d61d4640069452.mov2`	文件路径。
SuccessFileNames	Object[]	`-`	成功的任务列表。
TaskId	String	`6683adbab8cac7d04*****cce`	任务 ID。
Message	String	`-`	信息。
FileName	String	`1eb8debe45e4*****5822d61d4640069452.mov2`	文件路径。

请求示例

https://vod.volcengineapi.com?Action=SubmitBlockObjectTasks&Version=2023-07-01&SpaceName=vod_test&Operation=forbid&FileNamesUrlEncoded=1eb8debe45e48******2d61d4640069452.mov2&RefreshCdn=enable

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202407021535216ED92CEED629C0780377",
    "Action": "SubmitBlockObjectTasks",
    "Version": "2023-07-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "Operation": "forbid",
    "OperateFileNames": {
      "SuccessFileNames": [
        {
          "FileName": "1eb8debe45e4842f5822d61d4640069452.mov2",
          "Message": "",
          "TaskId": "6683adbab8cac7d04a704cce"
        }
      ],
      "FailedFileNames": []
    }
  }
}

错误码

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