获取 URL 封禁与解封任务列表--内容分发网络-火山引擎

文档中心

立即注册

导航

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

最近更新时间：2025.06.27 15:35:47首次发布时间：2021.11.30 14:02:09

对于符合查询条件的 URL，获取每个 URL 的封禁与解封任务的信息。您只能查询过去 92 天内的任务信息。

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

使用限制

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

请求说明

请求方式：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。如果不指定该参数，表示所有任务。说明由于每个任务最多可以封禁或解封 100 个 URL。如果您指定 TaskID 作为过滤条件之一，建议您指定指定 `PageSize` 为 `100`。不然，`PageSize` 的默认值可能会使某些符合条件的 URL 不包含在结果中。	`url_block_2021112616560901001104903915206`
TaskType	String	是	表示一个任务类型，用于对 URL 进行过滤，以获取该类型任务所操作的所有 URL。该参数有以下取值： `block_url`：表示封禁任务。 `unblock_url`：表示解封任务。 `block_regex`：表示基于正则表达式的封禁任务。 `unblock_regex`：表示基于正则表达式的解封任务。	`block_url`
Status	String	否	表示一个任务状态，用于对 URL 进行过滤，以获取该状态下任务所操作的所有 URL。该参数的可用值如下： `complete`：表示执行完成。 `running`：表示执行中。 `failed`：表示执行失败。如果不指定该参数，表示所有状态。	`complete`
StartTime	Long	否	表示一个开始时间，格式是 Unix 时间戳。对于提交时间晚于或等于该时间的任务，获取这些任务所操作的 URL。该参数默认值为该 API 提交时间前的 92 天。如果您指定了 `StartTime`，也必须指定 `EndTime`。	`1641844915`
EndTime	Long	否	表示一个结束时间，格式是 Unix 时间戳。对于提交时间早于或等于该时间的任务，获取这些任务所操作的 URL。该参数默认值为该 API 的提交时间。如果您指定了 `EndTime`，也必须指定 `StartTime`。	`1641845373`
PageNum	Long	否	表示一个页码。该 APi 返回该分页上 URL 的任务执行情况。该参数的默认值是 `1`。	`1`
PageSize	Long	否	表示每个分页包含的 URL 数量，取值范围是 1-1000，默认值是 `10`。	`10`
DomainName	String	否	表示一个加速域名，用于对 URL 进行过滤，以获取该域名下的 URL。如果不指定该参数，表示所有加速域名。	`www.test.com`
URL	String	否	表示指定的 URL。如果不指定该参数，表示所有 URL。	`https://www.a.com/1.jpg`

返回参数

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

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202506232127177E40C232A7F061275217",
        "Action": "DescribeContentBlockTasks",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-01"
    },
    "Result": {
        "Data": [
            {
                "BlockRegion": "chinese_mainland",
                "CreateTime": 1750684729,
                "Status": "complete",
                "TaskID": "url_block_8b33035645ab4e2895095b9418b3d1c7",
                "TaskType": "block_url",
                "Url": "https://www.example.com/hello.txt"
            },
            {
                "CreateTime": 1750684691,
                "Status": "complete",
                "TaskID": "url_block_22722e5e821b42e0b8ba5537db46c25c",
                "TaskType": "block_url",
                "Url": "http://www.example.com/file/2025-06-23/1.txt"
            }
        ],
        "PageNum": 1,
        "PageSize": 2,
        "Total": 5
    }
}

错误码

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