調用DescribeRefreshTasks查詢刷新、預熱狀態是否在全網生效。
接口說明
- 支持根據任務 ID 或 URL 查詢。
- 支持同時傳入 TaskId 和 ObjectPath 參數，如果不指定 TaskId 和 ObjectPath，默認查詢最近 3 天內第一頁的數據（20 條）。
- 只能查詢最近 3 天內的數據。
- 任務狀態需要由 API 的調用請求來觸發異步更新。
- 如果您在 OSS 控制臺開啟了 CDN 緩存自動刷新，則無法通過 DescribeRefreshTasks 接口查看 OSS 上的緩存自動刷新任務。
- 單用戶調用頻率：10 次/秒。如果您需要更高的調用頻率，請使用僅支持通過任務編號查詢刷新預熱任務信息的接口 DescribeRefreshTaskById 。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| cdn:DescribeRefreshTasks | none | *Domain acs:cdn:*:{#accountId}:domain/{#DomainName} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| TaskId | string | 否 | 按任務 ID 查詢刷新狀態。 | 1234321 |
| ObjectPath | string | 否 | 按路徑查詢，準確匹配。 | http://example.com/1.txt |
| PageNumber | integer | 否 | 取得第幾頁，取值范圍為：1~100000。 | 1 |
| ObjectType | string | 否 | 任務類型。取值：
說明
當指定 DomainName 或 Status 參數時，ObjectType 參數為必傳參數。
| file |
| DomainName | string | 否 | 加速域名。僅支持單個查詢，默認查詢所有加速域名。 | example.com |
| Status | string | 否 | 任務狀態。取值：
| Complete |
| PageSize | integer | 否 | 分頁大小，默認 20，最大 100。取值：1~100。 | 20 |
| StartTime | string | 否 | 開始時間。日期格式按照 ISO8601 表示法，并使用 UTC+0 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。 | 2017-12-21T08:00:00Z |
| EndTime | string | 否 | 結束時間。日期格式按照 ISO8601 表示法，并使用 UTC+0 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。 說明
結束時間需大于起始時間。
| 2017-12-22T08:00:00Z |
| ResourceGroupId | string | 否 | 資源組 ID。 | rg-acfmyuji4b6r4** |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "174F6032-AA26-470D-B90E-36F0EB205BEE",
"PageNumber": 10,
"PageSize": 1,
"TotalCount": 2,
"Tasks": {
"CDNTask": [
{
"Status": "Complete",
"CreationTime": "2014-11-27T08:23:22Z",
"ObjectType": "file",
"Process": "100%",
"Description": "Internal Error",
"ObjectPath": "http://example.com/1.txt",
"TaskId": "704225667"
}
]
}
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidTaskId.Malformed | The specified TaskId is invalid. | - |
| 400 | MissingParameter.ObjectType | The ObjectType parameter is required if DomainName or Status is specified. | - |
| 400 | MissingTimeParameter | The StartTime and EndTime must be both specified. | 請同時提供開始時間和結束時間。 |
| 400 | InvalidEndTime.Mismatch | The specified EndTime is earlier than the StartTime. | 用戶參數中EndTime早于StartTime |
| 400 | DomainNameOverLimit | A maximum of 500 domains are supported for each request. | - |
| 400 | InvalidTime | The query time cannot exceed the last 3 days. | - |
| 400 | InvalidStartTime.Malformed | The specified StartTime is invalid. | 起始時間格式錯誤。請核對后重新提供。 |
| 400 | InvalidEndTime.Malformed | The specified EndTime is invalid. | 結束時間格式錯誤。日期格式請參考所調用API的幫助文檔說明。 |
| 400 | InvalidObjectPath.Malformed | The specified ObjectPath is invalid. | - |
| 400 | InvalidStartTime.ValueNotSupported | The specified StartTime is invalid. | 起始時間格式錯誤。日期格式請參考所調用API的幫助文檔說明。 |
| 400 | InvalidEndTime.ValueNotSupported | The specified EndTime is invalid. | - |
| 400 | InvalidObjectType.ValueNotSupported | The specified ObjectType is not supported. | - |
| 400 | InvalidStatus.ValueNotSupported | The specified Status is not supported. | - |
| 429 | TooManyRequests | The server is busy. Please try again later. | 服務器正忙，請稍后再試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-02-22 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-03-29 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |