调用本接口将源站的内容主动预热到L2 Cache节点上，首次访问可直接命中缓存，缓解源站压力。
接口说明
说明
目前服务地址仅支持：华东 2（上海）。
同一账号每天最多可提交预热 URL 请求共 500 条，目前不支持目录级别的预热。
刷新预热类接口包含 RefreshVodObjectCaches 刷新接口和 PreloadVodObjectCaches 预热接口。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| 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" ] } |
返回参数
示例
正常返回示例
JSON格式
{
"PreloadTaskId": "9524****",
"RequestId": "E5BD4B50-7A02-493A-*****-97B9024B4135"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-07-03 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
接口错误码
下表列举了本接口特有的错误码。
| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |
|---|---|---|---|
| Throttling | Request was denied due to request throttling. | 503 | 请求被流量控制限制。 |
| IllegalOperation | Illegal domain operate is not permitted. | 403 | 非法域名, 无法操作。 |
| OperationDenied | Your account does not open VOD service yet. | 403 | 账号未开通视频点播服务。 |
| OperationDenied.Suspended | Your VOD service is suspended. | 403 | 账号已欠费，请充值。如果您欠费超过 15 天，续费后需要重新开通点播服务。 |
| InvalidDomain.NotFound | The domain provided does not belong to you. | 404 | 域名不存在或不属于当前用户。 |
| InvalidDomain.Offline | The domain provided is offline. | 404 | 域名已下线。 |
| QuotaExceeded.Refresh | You’ve exceeded the prescribed refresh limits. | 400 | 超出当日刷新限制。 |
| PreloadQueueFull | Preload queue is full, please try again later! | 403 | 预热队列已满（域名正在预热的 URL 个数已经达到上限），请稍后再试。 |
| InvalidDomain.Configure_failed | Failed to configure the provided domain. | 500 | 域名配置失败, 无法刷新。 |
| MissingParameter | The input parameter “ObjectPath” that is mandatory for processing this request is not supplied. | 400 | 缺少 ObjectPath 参数。 |
| InvalidObjectPath.Malformed | The specific value of parameter ObjectPath is malformed. | 400 | ObjectPath 值格式错误。 |
| InvalidExtensiveDomain.ValueNotSupported | Extensive domain not supported. | 400 | 不支持泛域名。 |
| InvalidObjectPath.Size.Malformed | The size of ObjectPath is bigger than 1000. | 400 | 预热 URL 个数一次不能超过 1000。 |