提交文件预热任务--多云CDN-火山引擎

文档中心

立即注册

导航

提交文件预热任务

最近更新时间：2024.12.16 14:13:46首次发布时间：2022.07.28 21:39:27

调用本接口提交文件预热任务到内置CDN服务和第三方云服务商平台。

使用说明

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

使用限制

节流限制：您每秒最多可以提交 50 个 API 请求。
以下云服务商产品不支持文件预热功能：AWS—CloudFront、Akamai—AMD 和 DSA、Google Cloud—Media CDN。

请求说明

请求方式：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的域名，或已同步到多云CDN的第三方加速域名。	`http://www.example.com/download.zip`
Vendor	String	否	为预热任务设置要提交到的云服务商。您可以设置一个或多个云服务商。多个云服务商之间以半角逗号（,）分隔。该参数有以下取值： `builtin`：内置加速 `aliyun`：阿里云 `tencent`：腾讯云 `ksyun`：金山云 `huawei`：华为云 `volcengine`：火山引擎 `wangsu`：网宿科技 `qiniu`：七牛云 `ucloud`：UCloud `akamai`：Akamai `baishan`：白山云 `aws`：AWS `baidu`：百度智能云 `jingdong`：京东云 `gcp`：Google Cloud `chinamobile`：中国移动 `ctcdn`：天翼云CDN+ `azure`：Azure 说明如果您未指定该参数，则多云CDN将根据 URL 中的域名自动匹配云服务商，并向所有匹配到的云服务商都提交预热任务。	`volcengine`

返回参数

参数名称	数据类型	参数说明	示例
TaskId	String	由本次预热请求生成的任务 ID。通过 `TaskIds` 参数获取所有任务 ID。	`62de5c5a56fd9eaa6c426b47`
TaskIds	String[]	由本次预热请求生成的任务 ID 组。当任务超过一定数量时，多云CDN会自动拆分出多个任务，该参数包含所有任务的 ID；如果没有自动拆分任务，该参数只返回一个任务 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",
        "TaskIds": [
            "62de5c5a56fd9eaa6c426b47"
        ]
    }
}

错误码

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