You need to enable JavaScript to run this app.
导航

提交刷新任务

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

首次发布时间2021.07.15 11:09:03

通过 API 请求提交刷新任务。支持 URL 刷新和目录刷新。

使用限制

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

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

  • URL 刷新任务:每天最多刷新 1000 个内容 URL。
  • 目录刷新任务:每天最多刷新 50 个内容 URL。
  • 任务刷新额度:每个任务最多刷新 100 个内容 URL。

您账号下的实际额度可能会与默认额度有差异。要查看实际额度,有以下两个方法:

如需调整任务的额度,请联系火山引擎服务技术支持

请求说明

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

请求参数

Query

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

Body

参数名称
数据类型
是否必选
参数说明
示例
Type
String

指定一个刷新类型。该参数的可用值如下:
file:URL 刷新。
dir:目录刷新。
regex:正则刷新。要使用正则刷新,请提交工单。关于正则刷新的 URL 规范,参见正则刷新

未指定时,默认为file
file
Prefix
Boolean

Typedir进行目录刷新时,可通过此配置开启前缀刷新:
true:开启前缀刷新;
false:关闭前缀刷新,进行标准的目录匹配刷新。

未指定时,默认为false
true
Urls
String

指定一个或多个内容 URL,内容 URL 以 http://https:// 开头。多个内容 URL 用\n分隔。

指定目录刷新时,需要以/结尾。
https://www.a.com/1.jpg\nhttps://www.b.com/2.jpg

响应正文

参数名称
数据类型
参数说明
示例
TaskID
String
代表提交的任务 ID。您可以使用该 ID 查询任务状态。
refresh_url_bbd36e1cb5154f52b648b07ee119223e2971399f5a1075c0

请求示例

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

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202201141648440102100180260E003ABA",
    "Action": "SubmitRefreshTask",
    "Version": "2021-03-01",
    "Service": "CDN",
    "Region": "cn-north-1"
  },
  "Result": {
    "TaskID": "refresh_url_bbd36e1cb5154f52b648b07ee119223e2971399f5a1075c0"
  }
}

错误码

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