DescribeVodRefreshTasks - 查詢重新整理和預熱狀態 -

調用本介面查詢重新整理和預熱狀態是否生效。

介面說明

目前服務地址僅支援：華東 2（上海）。
若 Taskid 與 Objectpath 都不指定，則預設查詢 3 天內，第一頁的資料（20 條）。Taskid 與 Objectpath 可以同時指定。
當指定 DomainName 或 Status 時，ObjectType 該項為必填。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

vod:DescribeVodRefreshTasks

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
TaskId	string	否	按任務 ID 查詢重新整理狀態。	70422****
ObjectPath	string	否	按路徑查詢，準確匹配。	http://example.com/***.txt
PageNumber	integer	否	頁碼。	1
ObjectType	string	否	任務類型。取值範圍： file：檔案重新整理。 directory：目錄重新整理。 preload：檔案預熱。說明當指定 DomainName 或 Status 時，ObjectType 該項為必填。	file
DomainName	string	否	網域名稱。	example.com
Status	string	否	任務狀態。取值： Complete：完成。 Refreshing：重新整理中。 Failed：重新整理失敗。	Complete
PageSize	integer	否	分頁大小，每頁顯示的條目數。預設值：20。最大值：50。	20
StartTime	string	否	開始時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。說明僅能查詢 3 天內的資料。	2017-01-01T12:12:20Z
EndTime	string	否	結束時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2017-01-01T12:30:20Z

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	174F6032-AA26-470D-****-36F0EB205BEE
PageNumber	integer	頁碼。	1
PageSize	integer	整頁大小。	10
TotalCount	integer	總條數。	2
Tasks	object
Task	array<object>	TaskItem 組成的 Task 工作清單。
	object
Status	string	狀態。取值： Complete：完成。 Refreshing：重新整理中。 Failed：重新整理失敗。 Pending：等待重新整理。	Complete
CreationTime	string	任務對象建立時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2014-11-27T08:23:22Z
ObjectType	string	任務類型。取值： file 預設：檔案重新整理。 directory：目錄重新整理。 preload：檔案預熱。	file
Process	string	進度百分比。	100%
Description	string	重新整理預熱失敗返回的錯誤描述。目前有三種： Internal Error：內部錯誤。 Origin Timeout：來源站點響應逾時。 Origin Return StatusCode 5XX：來源站點返回 5XX 狀態代碼。	Internal Error
ObjectPath	string	重新整理物件路徑。	http://example.com/****.txt
TaskId	string	任務 ID。	704225667

樣本

正常返回樣本

JSON格式

{
  "RequestId": "174F6032-AA26-470D-****-36F0EB205BEE",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 2,
  "Tasks": {
    "Task": [
      {
        "Status": "Complete",
        "CreationTime": "2014-11-27T08:23:22Z",
        "ObjectType": "file",
        "Process": "100%",
        "Description": "Internal Error",
        "ObjectPath": "http://example.com/****.txt",
        "TaskId": "704225667"
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidTaskId.Malformed	The specified TaskId is invalid.	TaskId無效
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	必須同時指定開始時間和結束時間
400	MissingParameter.ObjectType	The ObjectType parameter is required if DomainName or ObjectType is specified.
400	InvalidStartTime.Malformed	The specified StartTime is invalid.
400	InvalidEndTime.Malformed	The specified EndTime is invalid.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	結束時間早於開始時間
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.
400	InvalidObjectType.ValueNotSupported	The specified ObjectType is not supported.
400	InvalidStatus.ValueNotSupported	The specified Status is not supported.
400	DomainNameOverLimit	A maximum of 500 domains are supported for each request.	每個請求最多500個網域名稱
400	InvalidTime	The query time cannot exceed the last 3 days.	請求時間返回不能超過3天

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

變更歷史

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