文档中心

提交 URL 解封任务

最近更新时间：2024.04.02 17:39:10

首次发布时间：2021.12.01 10:27:10

通过 API 请求提交解封 URL 任务。解封 URL 任务提交后，CDN 对终端用户将解除对任务提交的 URL 的封禁策略，并向终端用户正常响应文件内容。
解封任务提交后，用户可以正常访问被解封的 URL。对于指定需要被解封的 URL，内容分发网络提供了两种方法：

指定具体的 URL。
指定正则表达式匹配多个 URL。

说明

要使用该 API，请提交工单。
之后，如果您需要在 API 请求中使用正则表达式，您需要额外提交工单。或者，您可以在第一次提交工单时指明您需要使用该 API 以及正则表达式。

使用限制

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

默认情况下，每个火山引擎账号下的任务额度如下：

URL 解封额度：每日最多解封 3,000 个内容 URL。
单次任务的 URL 解封额度：每个任务最多解封 100 个内容 URL。
本接口为白名单功能，您的账号下的实际额度可能会与默认额度有差异。如需开通该接口或者调整任务额度，请联系火山引擎服务技术支持。

请求说明

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

请求参数

Query

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

Body

参数名称	数据类型	是否必选	参数说明	示例
Urls	String	是	表示需要解封的 URL。如果 `Type` 是 `url`，您需要指定一个或者多个文件 URL。每个 URL 都必须以 `http://` 或 `https://` 开头。多个 URL 之间使用 `\n` 分隔。如果 `Type` 是 `regex`，您需要指定一个或者多个正则表达式用于匹配需要被解封的文件 URL。多个正则表达式之间使用换行分隔。一个加速域名最多可以包含 20 个用于解封的正则表达式。正则表达式在匹配时是区分大小写的。您指定的正则表达式必须符合以下要求：每个正则表达式不能超过 256 个字符。正则表达式匹配的是文件路径部分，不包含路径开头的 `/`。路径包含查询参数。也就是说，正则表达式能匹配的 URL 的格式是 `http://<host>/<regex>` 或者 `https://<host>/<regex>`。`<host>` 表示加速域名，`<regex>` 表示正则表达式。正则表达式中只能包含以下元字符： [0-9] [a-z] [A-Z] [a-zA-Z] [^/]* .* [,?] ? 说明 URL 中不能包含泛域名。您不能直接通过指定一个包含泛域名的 URL 来对多个子域名下的文件执行解封操作。您必须为每个域名指定解封 URL。参见如何对泛域名下的文件和目录执行刷新、预热、封禁和解封操作。	`文件 URL 示例：https://www.a.com/1.jpg\nhttps://www.b.com/2.jpg 正则表达式示例：https://www.example.com/a[0-5]c/[0-9][a-z].*\.js\?a=[a-z]`
Type	String	否	表示解封类型。该参数的有以下取值： `url`：表示对指定的文件 URL 进行解封。 `regex`：表示对匹配指定的正则表达式的文件 URL 进行解封。该参数的默认值是 `url`。	`url`

响应正文

参数名称	数据类型	参数说明	示例
TaskID	String	表示提交的任务 ID。您可以调用 DescribeContentTasks 查看 `Urls` 列表中每个 URL 的执行状态。	`url_unblock_2021112615553701001104903919667`

请求示例

POST https://cdn.volcengineapi.com/?Action=SubmitUnblockTask&Version=2021-03-01
{
  "Urls": "https://www.a.com/1.txt\nhttps://www.b.com/2.txt"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202111261555370102111971442000B8EB",
    "Action": "SubmitUnblockTask",
    "Version": "2021-03-01",
    "Service": "CDN",
    "Region": "cn-north-1"
  },
  "Result": {
    "TaskID": "url_unblock_2021112615553701001104903919667"
  }
}

错误码

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