全部產品
Search

搜尋本產品

    CDN：DescribePreloadDetailById - 查詢預熱任務詳情

    文件中心

    CDN：DescribePreloadDetailById - 查詢預熱任務詳情

    更新時間：Dec 14, 2025

    查詢任務預熱詳情，包括任務下所有資源的預熱進度。該介面需要申請白名單後才可以使用，頻寬大於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

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。