You need to enable JavaScript to run this app.
导航
内容分发网络
  • 文档首页
    • /
  • 内容分发网络

获取 URL 封禁与解封任务列表

最近更新时间：2024.01.25 20:28:21

首次发布时间：2021.11.30 14:02:09

我的收藏

通过 API 请求查询已提交封禁、解封任务的执行状态。

使用限制

节流限制：您每秒最多可以发送 20 个请求。

数据保留期限：系统保留最近 92 天封禁、解封任务的数据，不支持 92 天以前任务的数据查询。

要使用该 API，请提交工单。

请求说明

  • 请求方式：POST
  • 请求地址：https://cdn.volcengineapi.com/?Action=DescribeContentBlockTasks&Version=2021-03-01

请求参数

Query

参数名称
数据类型
是否必选
参数说明
Action
String
是
接口名称。当前 API 的名称为 DescribeContentBlockTasks。
Version
String
是
接口版本。当前 API 的版本为 2021-03-01。

Body

参数名称
数据类型
是否必选
参数说明
示例
TaskID
String
否
指定一个封禁或解封的任务 ID，获取该任务所包含的 URL 的信息。如果不指定该参数，表示包含所有任务。
url_block_2021112616560901001104903915206
TaskType
String
是

指定一个任务类型，获取属于该类型任务的 URL 的信息。该参数有以下取值：

  • block_url：表示封禁任务。
  • unblock_url：表示解封任务。
  • block_regex：表示基于正则表达式的封禁任务。
  • unblock_regex：表示基于正则表达式的解封任务。
block_url
Status
String
否

指定一个任务状态，获取该状态下的 URL 的信息。该参数的可用值如下：

  • complete：表示执行完成。
  • running：表示执行中。
  • failed：表示执行失败。
如果不指定该参数，表示包含所有任务状态。
complete
StartTime
Long
否
指定一个时间，时间格式是 Unix 时间戳。该时间用以包含提交时间大于或等于该时间的任务。您无法查询超过 92 天的任务。
1641844915
EndTime
Long
否
指定一个时间，时间格式是 Unix 时间戳。该时间用以包含提交时间小于或等于该时间的任务。您无法查询超过 92 天的任务。
1641845373
PageNum
Long
否

指定一个页码。系统只返回该页面上的 URL 的信息。

默认值为 1。如果指定的页码不存在，则返回空值。响应正文中返回的任务包含在一个或者多个页面上。建议第一次提交查询时使用默认值。您可以根据响应正文中的Total 和 PageSize 参数的值计算结果页数。然后你就可以在查询中指定一个 PageNum 来获取该页面上的那些任务。
1
PageSize
Long
否

指定响应正文中每页包含的 URL 数量。

默认值是10。
10
DomainName
String
否
指定一个加速域名，获取该加速域名下的 URL 的信息。如果不指定该参数，表示包含所有加速域名。
www.test.com
URL
String
否
指定一个 URL 或者一个正则表达式，获取匹配的 URL 的信息。如果不指定该参数，表示包含所有 URL。
https://www.a.com/1.jpg

说明

由于每个任务最多可以封禁或解封 100 个内容 URL，建议在使用一个 TaskID 查询任务时，指定 PageSize 为 100。如果不指定一个 PageSize，响应正文最多会包含 10 个内容 URL。因此某些内容 URL 可能不会包含在响应正文中。

响应正文

参数名称
数据类型
参数说明
示例
Total
Long
表示符合查询条件的 URL 总数。
2
PageNum
Long
表示当前页码。 该值与请求正文中的 PageNum 值相同。
1
PageSize
Long
表示每页的 URL 数量。
100
Data
Object[]
表示符合查询条件的 URL 列表。列表中每个元素表示一个 URL 的信息。

请求示例

POST https://cdn.volcengineapi.com/?Action=DescribeContentBlockTasks&Version=2021-03-01
{
  "StartTime": 1625587200,
  "EndTime": 1625673600,
  "TaskType": "block_url",
  "PageSize": 10,
  "PageNum": 1
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202107071614380102040541590202DB57",
    "Action": "DescribeContentBlockTasks",
    "Version": "2021-03-01",
    "Service": "CDN",
    "Region": "cn-north-1"
  },
  "Result": {
    "Data": [
      {
        "Url": "http://www.example.com/1.txt",
        "Status": "failed",
        "TaskType": "block_url",
        "CreateTime": 1625643834,
        "TaskID": "url_block_2021112616560901001104903915206",
        "BlockReason": "req_from_other"
      },
      {
        "Url": "http://www.example.com/2.txt",
        "Status": "failed",
        "TaskType": "block_url",
        "CreateTime": 1625643834,
        "TaskID": "url_block_2021112616560901001104903915206",
        "BlockReason": "req_from_other"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "Total": 2
  }
}

错误码

如果响应正文的 ResponseMetadata 字段中包含 Error 字段，则表示 API 请求失败。更多关于错误码的信息，参见错误码。