You need to enable JavaScript to run this app.
导航
视频点播
  • 文档首页
    • /视频点播/API 参考/媒资管理/媒资封禁/获取媒资封禁或解禁任务
获取媒资封禁或解禁任务
最近更新时间：2024.09.19 17:51:58首次发布时间：2024.07.19 17:11:57
我的收藏

此接口用于获取指定空间下已提交的封禁或解禁任务。

注意事项

  • 请求频率：单用户请求频率限制为 20 次/秒。
  • 亚太东南（柔佛）地域暂不支持此接口。

请求说明

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

调试

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

请求参数

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

参数
类型
是否必选
示例值
描述
Action
String
是
ListBlockObjectTasks
接口名称。当前 API 的名称为 ListBlockObjectTasks。
Version
String
是
2023-07-01
接口版本。当前 API 的版本为 2023-07-01。
SpaceName
String
是
test

点播空间名称。可通过以下方式获取空间名称：

  • 在视频点播控制台空间管理页面查看当前账号下所有空间的名称。
  • 调用 ListSpace 接口获取当前账号下所有空间的名称。

说明

如果您在一次请求中仅传入点播空间名称，将返回最近的 100 条任务记录。

FileNamesUrlEncoded
String
否
a%2Fb%2Fc

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 才看到返回数据。
TaskIds
String
否
667e78608f901****0915b73
封禁或解禁任务 ID。多个 ID 用英文逗号 , 连接，一次最多传入 20 个。可在 SubmitBlockObjectTasks 接口的返回参数中获取。

返回参数

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

参数
类型
示例值
描述
ObjectBlockTaskInfos
Object[]
-
封禁或解封的任务信息。
Status
String
complete

封禁状态，表示源站是否完成媒资封禁。取值如下：

  • forbid：已封禁
  • recover：已解封
  • configuring：配置中
TaskId
String
6683adbab8cac7d04a7****e
任务 ID。
FileName
String
1eb8debe45e4842f5822d61****40069452.mov2
文件路径。
Operation
String
forbid

封禁任务类型。取值如下：

  • forbid：封禁任务
  • recover：解封任务
RefreshInfos
Object[]
-
刷新任务信息。
Url
String
http://vod-month02.****-test.com/1eb8debe4*****d4640069452.mov2
刷新的 URL。
Status
String
running

任务状态，取值如下：

  • complete：已完成。
  • running：执行中。
  • failed：执行失败。
Process
String
70%
任务进度，单位为 %。
RefreshStatus
String
running

刷新缓存状态。取值如下：

  • complete：完成，可能部分成功。
  • running 运行中，刷新中。
  • waiting：等待中，原站封禁中，还未刷新。
  • notRequired：不被请求，不需要刷新。
RefreshTaskId
String
refresh_url_7f4efff***2fffbf649677c
刷新任务 ID。

请求示例

https://vod.volcengineapi.com?Action=ListBlockObjectTasks&Version=2023-07-01&SpaceName=vod_test&TaskIds=667e78608*****740915b73

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240702153800283803E0ADD9F2924147",
    "Action": "ListBlockObjectTasks",
    "Version": "2023-07-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "ObjectBlockTaskInfos": [
      {
        "Status": "complete",
        "TaskId": "6683adbab8ca***04a704cce",
        "FileName": "1eb8debe45e48****822d61d4640069452.mov2",
        "RefreshStatus": "complete",
        "Operation": "forbid",
        "RefreshTaskId": "refresh_url_7f4effbcaa3f4e8397947434b17787233cd2fffbf649677c",
        "RefreshInfos": [
          {
            "Url": "http://vod-month02.****-test.com/1eb8debe45e4842*****d4640069452.mov2",
            "Status": "complete",
            "Process": "100%"
          }
        ]
      }
    ]
  }
}

错误码

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