调用本接口将源站的内容主动预热到L2 Cache节点上,首次访问可直接命中缓存,缓解源站压力。
接口说明
目前服务地址仅支持:华东 2(上海)。
同一账号每天最多可提交预热 URL 请求共 500 条,目前不支持目录级别的预热。
刷新预热类接口包含 RefreshVodObjectCaches 刷新接口和 PreloadVodObjectCaches 预热接口。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
vod:PreloadVodObjectCaches |
update |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ObjectPath |
string |
是 |
预热文件 URL。多个 URL 使用换行符(\n 或\r\n)分隔。 |
vod.test.com/test.txt |
| Area |
string |
否 |
预热区域,取值:domestic, overseas。 |
domestic |
| L2Preload |
boolean |
否 |
是否直接预热到 L2 节点。取值:
|
true |
| WithHeader |
string |
否 |
预热请求默认携带的 header 是 Accept-Encoding:gzip,如果您需要预热请求携带其他 header,或者实现多副本预热,那么可以使用该参数来实现自定义预热 header。用 JSON 串格式提交。 |
{ "Accept-Encoding": [ "gzip, deflate, br" ] } |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回结果。 |
||
| PreloadTaskId |
string |
预热返回的任务 ID。多个任务 ID 用半角逗号(,)分隔。 |
9524**** |
| RequestId |
string |
请求 ID。 |
E5BD4B50-7A02-493A-*****-97B9024B4135 |
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | SingleRequest.OverLimit | A maximum of 1000 URLs are supported for each request. | |
| 400 | QuotaExceeded.Preload | Your refresh attempts have exceeded the daily limit. | |
| 400 | InvalidObjectPath.Malformed | The specified ObjectPath is invalid. | 参数ObjectPath无效。 |
| 400 | InvalidExtensiveDomain.ValueNotSupported | The specified ExtensiveDomain is not supported. | |
| 400 | PreloadQueueFull | The warming queue is full; please try again later. | |
| 400 | InvalidCustomHeader | Parse preload header failed. | 解析preload header失败 |
| 404 | InvalidDomain.Offline | The domain provided is offline. | |
| 404 | InvalidDomain.NotFound | The domain provided does not belong to you. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。