Querying a Cache Purge or Prefetch Task
Function
This API is used to query details about a cache purge or prefetch task.
URI
GET /v1.0/cdn/historytasks/{history_tasks_id}/detail
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
history_tasks_id |
Yes |
String |
Task ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
ID of the enterprise project to which the resource belongs. This parameter is valid only when the enterprise project function is enabled. The value all indicates all projects. This parameter is mandatory when you use an IAM user to call this API. Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS). |
page_size |
No |
Integer |
Maximum number of URLs for purge and prefetch on each page. The value ranges from 1 to 10,000. Both page_size and page_number must be set. Default value: 30. |
page_number |
No |
Integer |
Number of the page to be queried. The value ranges from 1 to 65,535. Default value: 1. |
status |
No |
String |
URL status. Possible values: processing, succeed, failed, waiting, refreshing, and preheating. |
url |
No |
String |
URL. |
create_time |
No |
Long |
Time when a task was created. If this parameter is not passed, tasks within the last seven days are queried by default. Data within the last 15 days can be queried. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
Task ID. |
task_type |
String |
Task type. Possible values: refresh (cache purge) and preheating (cache prefetch). |
status |
String |
Task execution result. Possible values: task_done (successful) and task_inprocess (processing). |
urls |
Array of UrlObject objects |
URL list. |
create_time |
Long |
Creation time. |
processing |
Integer |
Number of URLs that are being processed. |
succeed |
Integer |
Number of URLs processed. |
failed |
Integer |
Number of URLs that failed to be processed. |
total |
Integer |
Total number of URLs in historical tasks. |
file_type |
String |
File type. Possible values: file (default value) and directory. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
URL ID. |
url |
String |
URL. |
status |
String |
URL status. Possible values: processing, succeed, failed, waiting, refreshing, and preheating. |
create_time |
Long |
Time when the URL was created. The value is the number of milliseconds since the UNIX epoch (Jan 1, 1970). |
task_id |
String |
Task ID. |
task_type |
String |
Task type. Possible values: REFRESH (purge), PREHEATING (prefetch), or REFRESH_AFTER_PREHEATING (purge after prefetch). |
Example Requests
GET https://cdn.myhuaweicloud.com/v1.0/cdn/historytasks/ff808***********************b39/detail?page_size=10&page_number=1&enterprise_project_id=0
Example Responses
Status code: 200
OK
{ "id" : "ff80808xxxxxxxxx64797", "status" : "task_inprocess", "processing" : 2, "succeed" : 0, "failed" : 0, "urls" : [ { "url" : "http://www.example1.example2.com/index.html", "id" : "ff80808264exxxxxxxxx60c4fe74798", "status" : "processing", "create_time" : 1532867923942, "task_id" : "ff80808xxxxxxxxx64797", "task_type" : "PREHEATING" }, { "url" : "http://www.example1.example2.com/web", "id" : "ff80808*******************4799", "status" : "processing", "create_time" : 1532867923942, "task_id" : "ff80808xxxxxxxxx64797", "task_type" : "PREHEATING" } ], "task_type" : "preheating", "total" : 2, "create_time" : 1532867923942, "file_type" : "file" }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot