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

创建文件预热任务

最近更新时间2023.09.06 11:03:27

首次发布时间2022.07.28 21:39:27

API 说明

API 名称:SubmitPreloadTask
API 域名:open.volcengineapi.com
API 描述:通过多云CDN创建文件预热任务。您创建的任务将下发到云服务商的 CDN 。

请求方法

POST

使用限制

  • 节流限制:每秒最多提交 50 个请求。
  • 云服务商 CDN 接口的限制:
    多云CDN调用云服务商 CDN 的相关接口以下发文件预热任务。由于云服务商 CDN 接口能力的限制,多云CDN不支持向以下 CDN 下发文件预热任务:
    • Akamai AMD/DSA

公共查询参数

在调用该 API 时,您在请求中必须包含公共参数。在这些公共参数中,以下两个查询参数的取值说明如下:

参数名称
数据类型
是否必选
参数说明
Action
String
API 的名称。该参数的取值是 SubmitPreloadTask
Version
String
API 的版本。该参数的取值是 2022-03-01

请求正文

参数名称数据类型是否必选参数说明示例
UrlsString表示一个或者多个需要预热的 URL。
  • 多个 URL 以\n分隔。最多可以输入 20 个 URL。
  • URL 必须以http://https://开头。
  • URL 中的域名必须已同步到多云CDN。
参见请求示例
VendorString表示将这些预热 URL 提交到一个或多个指定的云服务商。多个云服务商以半角逗号(,)分隔。如果不指定该参数,则由多云CDN自动选择匹配的云服务商提交预热任务。该参数有以下取值:
  • aliyun:阿里云
  • tencent:腾讯云
  • ksyun:金山云
  • huawei:华为云
  • volcengine:火山引擎
  • wangsu:网宿科技
  • qiniu:七牛云
  • ucloud:UCloud
  • akamai:Akamai
  • baishan:白山云
  • aws:AWS
  • baidu:百度智能云
  • jingdong:京东云
volcengine

响应正文

参数名称数据类型参数说明示例
TaskIdString表示在多云CDN上创建的预热任务的 ID。62de5c5a56fd9eaa6c426b47

示例

请求示例

POST https://open.volcengineapi.com?Version=2022-03-01&Action=SubmitPreloadTask&<其他公共请求参数>
{
    "Urls":"http://www.example.com/\nhttps://www.test.com/"
}

响应示例

{
    "ResponseMetadata": {
        "RequestID": "202207251703200102121500340EA9B56C",
        "Action": "SubmitPreloadTask",
        "Version": "2022-03-01",
        "Service": "mcdn",
        "Region": "cn-north-1"
    },
    "Result": {
        "TaskId": "62de5c5a56fd9eaa6c426b47"
    }
}

错误代码

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