全部产品
Search

搜索本产品

    CDN：DescribePreloadDetailById - 查询预热任务详情

    文档中心

    CDN：DescribePreloadDetailById - 查询预热任务详情

    更新时间：Aug 27, 2026

    查询任务预热详情，包括任务下所有资源的预热进度。该接口需要申请白名单后才可以使用，带宽大于100Gbps的情况下，可以通过您的商务经理申请白名单。

    接口说明

    • 支持查询 3 天内（包含 3 天）的数据。

    • 单用户调用频率为：30 次/秒。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    调试

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    cdn:DescribePreloadDetailById

    get

    *全部资源

    *

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    TaskId

    string

    是

    按任务 ID 查询预热任务详情。 支持单次查询一个任务 ID。

    15423123921

    返回参数

    名称

    类型

    描述

    示例值

    object

    TotalCount

    integer

    查询到的总任务数

    1
    RequestId

    string

    请求的 ID。用于定位日志，排查问题。

    E9D3257A-1B7C-414C-90C1-8D07AC47BCAC
    UrlDetails

    array<object>

    任务详情。包括任务 ID、起止时间、域名、成功率、状态、返回错误码、以及所有 url 资源的完成详情。

    array<object>

    TaskId

    string

    待查询的任务 ID。

    您可以调用 PushObjectCache 接口，从其返回值中获取预热任务的 ID，并通过任务 ID 查询源站资源的预热状态。

    支持同时传入单个任务 ID。

    14286878547
    Domain

    string

    预热资源的域名

    example.com
    CreationTime

    string

    任务对象创建时间，使用 UTC 时间表示。

    2022-11-23T02:26:56Z
    EndTime

    string

    任务对象结束时间，使用 UTC 时间表示。

    2022-11-23T02:27:00Z
    RetCode

    string

    返回的错误码，0表示成功。

    0
    Process

    string

    任务完成进度百分比，代表预热任务在多少边缘节点上已结束。

    100%
    Status

    string

    任务状态。取值：

    • Complete：完成。

    • Refreshing：进行中。

    • Failed：任务失败。

    Complete
    Urls

    array<object>

    该任务下所有 url 资源的完成详情。

    object

    Url

    string

    预热资源的 url。

    /abc.jpg

    Success

    string

    成功百分比。表示该资源在多少边缘节点上预热成功。

    47%
    Description

    string

    资源预热详情。

    • 若全部边缘节点成功，则返回"Successfully preloaded"

    • 若存在边缘节点失败，则返回失败详情，用"|"分隔。

    Successfully preloaded

    示例

    正常返回示例

    JSON格式

    {
  "TotalCount": 1,
  "RequestId": "E9D3257A-1B7C-414C-90C1-8D07AC47BCAC",
  "UrlDetails": [
    {
      "TaskId": "14286878547",
      "Domain": "example.com",
      "CreationTime": "2022-11-23T02:26:56Z",
      "EndTime": "2022-11-23T02:27:00Z",
      "RetCode": "0",
      "Process": "100%",
      "Status": "Complete",
      "Urls": [
        {
          "Url": "/abc.jpg\n",
          "Success": "47%",
          "Description": "Successfully preloaded"
        }
      ]
    }
  ]
}

    错误码

    HTTP status code

    错误码

    错误信息

    描述
    400 InvalidTaskId.Malformed The specified TaskId is invalid.
    400 DomainNameOverLimit A maximum of 500 domains are supported for each request.
    400 InvalidParameters The parameters you provided are invalid.
    400 InvalidTime The query time cannot exceed the last 3 days.
    429 TooManyRequests Too many requests, please try again later

    访问错误中心查看更多错误码。

    变更历史

    更多信息，参考变更详情。