创建预热任务

最近更新时间:2025-06-06 02:07:23

我的收藏

1. 接口描述

接口请求域名: teo.tencentcloudapi.com 。

创建预热任务

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreatePrefetchTask。
Version String 公共参数,本接口取值:2022-09-01。
Region String 公共参数,此参数为可选参数。
ZoneId String 站点 ID。
若您希望快速提交不同站点下的 Targets Url,可以将其填写为 *,但前提是调用该 API 的账号必须具备主账号下全部站点资源的权限。
Targets.N Array of String 要预热的资源列表,每个元素格式类似如下:
http://www.example.com/example.txt。参数值当前必填。
注意:提交任务数受计费套餐配额限制,请查看 EO计费套餐
Headers.N Array of Header 附带的http头部信息。
PrefetchMediaSegments String 媒体分片预热控制,取值有:
  • on:开启分片预热,预热描述文件,并递归解析描述文件分片进行预热;
  • off:仅预热提交的描述文件;
  • 不填写时,默认值为 off。

    注意事项:
    1. 支持的描述文件为 M3U8,对应分片为 TS;
    2. 要求描述文件能正常请求,并按行业标准描述分片路径;
    3. 递归解析深度不超过 3 层;
    4. 解析获取的分片会正常累加每日预热用量,当用量超出配额时,会静默处理,不再执行预热。

    该参数为白名单功能,如有需要,请联系腾讯云工程师处理。

    3. 输出参数

    参数名称 类型 描述
    JobId String 任务 ID。
    FailedList Array of FailReason 失败的任务列表。
    注意:此字段可能返回 null,表示取不到有效值。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 预热URL

    提交预热任务。

    输入示例

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreatePrefetchTask
    <公共请求参数>
    
    {
        "Targets": [
            "http://www.qq.com/a.txt"
        ],
        "ZoneId": "zone-ajj243dwrew",
        "EncodeUrl": true
    }

    输出示例

    {
        "Response": {
            "JobId": "20ga521cpwch",
            "FailedList": [],
            "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    InternalError.BackendError 后台处理出错。
    InternalError.DomainConfig 获取配置失败。
    InternalError.FailedToGenerateUrl 上传链接生成失败。
    InternalError.QuotaSystem 配额系统处理失败。
    InvalidParameter.DomainNotFound 域名不存在或不属于该账号。
    InvalidParameter.ParameterError 参数错误: 无效 "结束时间", 不在允许的查询范围内: [开始时间, 开始+ 7天]
    InvalidParameter.Target 资源存在错误。
    InvalidParameter.TaskNotGenerated 任务无法生成。
    InvalidParameter.UploadUrl 文件上传链接存在问题。
    LimitExceeded.BatchQuota 本次提交的资源数超过上限。
    LimitExceeded.DailyQuota 当天提交的资源数超过上限。
    UnauthorizedOperation.CamUnauthorized Cam 未授权。
    UnauthorizedOperation.NoPermission 子账户没有操作权限,请添加权限后继续操作。
    UnauthorizedOperation.Unknown 后端服务器发生未知错误。