You need to enable JavaScript to run this app.
导航
提交文件预热任务
最近更新时间:2024.04.22 11:04:22首次发布时间:2022.07.28 21:39:27

调用本接口提交文件预热任务到云服务商平台。

使用说明

每个请求中必须包含鉴权信息。该鉴权信息用以验证请求者的身份。参见签名机制

使用限制

  • 节流限制:您每秒最多可以提交 50 个 API 请求。
  • 云服务商平台接口限制:
    • 以下云服务商产品不支持文件预热功能:Akamai—AMD 和 DSA、Google Cloud—Media CDN。
    • AWS—CloudFront 默认不支持文件预热功能,但是您可以在 AWS 中完成特定配置以实现该功能。更多信息,请参见部署 AWS 预热解决方案

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com/?Action=SubmitPreloadTask&Version=2022-03-01

请求参数

Query

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

Body

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

设置一个或者多个需要预热的 URL。

  • 多个 URL 以\n分隔。最多可以输入 100 个 URL。
  • URL 必须以http://https://开头。
  • URL 中的域名必须是某个已同步到多云CDN的加速域名。
http://www.example.com/download.zip
Vendor
String

为预热任务设置要提交到的云服务商。您可以设置一个或多个云服务商。多个云服务商之间以半角逗号(,)分隔。该参数有以下取值:

  • aliyun:阿里云
  • tencent:腾讯云
  • ksyun:金山云
  • huawei:华为云
  • volcengine:火山引擎
  • wangsu:网宿科技
  • qiniu:七牛云
  • ucloud:UCloud
  • akamai:Akamai
  • baishan:白山云
  • aws:AWS
  • baidu:百度智能云
  • jingdong:京东云
  • gcp:Google Cloud
  • chinamobile:中国移动
  • ctcdn:天翼云CDN+

说明

如果您未指定该参数,则多云CDN将根据 URL 中的域名自动匹配云服务商,并向所有匹配到的云服务商都提交预热任务。

volcengine

响应正文

参数名称
数据类型
参数说明
示例
TaskId
String

多云CDN为该预热任务生成的任务 ID。

说明

您可以使用该任务 ID 调用 DescribeContentTaskByTaskId 接口,查询任务的执行状态。

62de5c5a56fd9eaa6c426b47

请求示例

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

返回示例

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

错误码

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