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

文档中心

导航

提交海外文件预热任务

最近更新时间：2025.01.15 10:17:08首次发布时间：2025.01.15 10:17:08

调用本接口提交海外云服务商文件预热（简称“海外文件预热”）任务。

注意

海外文件预热的工作原理是模拟海外用户向云服务商边缘节点发送 HTTP 或 HTTPS 请求，通过请求特定文件使文件从源站预取到边缘节点。实施海外文件预热会产生边缘请求，从而产生边缘流量。这部分流量会在云服务商平台计费。更多信息，请参见海外文件预热。

使用限制

节流限制：您每秒最多可以提交 50 个 API 请求。
只有高级版和旗舰版订阅套餐支持海外文件预热功能。
仅支持向以下云服务商产品提交海外文件预热请求：
- Akamai—AMD 和 DSA
- AWS—CloudFront
- Azure—CDN

请求说明

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

请求参数

Query

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

Body

参数名称	数据类型	是否必选	参数说明	示例
Urls	String	是	设置要预取的文件 URL 列表。 URL 必须以 `http://` 或者 `https://` 开头。多个 URL 间使用换行符（`\n`）分隔。最多可设置 100 个 URL。单日提交的所有海外文件预热任务包含的 URL 总数不超过 1,000 个。 URL 中的域名必须是从支持的海外云服务商产品同步到多云CDN的加速域名。加速域名的加速状态必须是“已启用”或“部署中”。说明您可以调用ListCdnDomains接口查询同步到多云CDN的加速域名。（将请求参数 `Vendor` 设置为 `["akamai","aws","azure"]`。）	`http://a.example.com/download.zip\nhttp://b.example.com/download.zip`
Vendor	String	是	设置将该任务提交给哪些云服务商。该参数有以下取值：`akamai`、`aws`、`azure` 允许指定多个云服务商。多个云服务商之间以半角逗号（,）分隔。	`akamai,aws`
Area	String	是	设置您希望海外文件预热生效的国家或地区代码。您可以调用ListViews接口获取国家或地区的代码列表（`Countries.Code`）。允许指定多个国家或地区代码。多个代码间以半角逗号（,）分隔。任务提交成功后，多云CDN将利用所选择国家或地区的终端向云服务商边缘节点发起请求，请求 `Urls` 参数所指定的文件。注意国家或地区越多，边缘请求产生的边缘流量越多。	`US,GB`

返回参数

参数名称	数据类型	参数说明	示例
TaskId	String	由本次海外文件预热请求生成的（首个）任务 ID。	`62de5c5a56fd9eaa6c426b47`
TaskIds	String[]	由本次海外文件预热请求生成的任务 ID 组。	`62de5c5a56fd9eaa6c426b47`

请求示例

POST https://open.volcengineapi.com/?Action=SubmitOverseaPreloadTask&Version=2022-03-01
{
    "Urls": "http://a.example.com/download.zip\\nhttp://b.example.com/download.zip",
    "Area": "US",
    "Vendor": "akamai,aws"
}

返回示例

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

错误码

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