DescribePreloadDetailById - CDN - Alibaba Cloud Documentation Center

Queries the prefetch details of a task, including the prefetch progress of all resources in the task. Only users who are included in the whitelist can use this operation. If your bandwidth is greater than 100 Gbit/s, contact your business manager to apply for the whitelist.

Operation description

You can query data within the last 3 days.
You can call this operation up to 30 times per second per account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
TaskId	string	Yes	Queries the details of a preload task by task ID. You can query one task ID at a time.	15423123921

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	long	The number of queried tasks.	1
RequestId	string	The ID of the request. You can use the ID to query logs and troubleshoot issues.	E9D3257A-1B7C-414C-90C1-8D07AC47BCAC
UrlDetails	object []	The details of the task, including the task ID, start time, end time, domain name, success rate, status, returned error code, and completion details of all URL resources.
TaskId	string	The ID of the task that you want to query. You can call the PushObjectCache operation to query task IDs. Then, you can use the task IDs to query task status. You can query one task ID at a time.	14286878547
Domain	string	The domain name for prefetching resources.	example.com
CreationTime	string	The time when the task was created. The time is displayed in UTC.	2022-11-23T02:26:56Z
EndTime	string	The time when the task ended. The time is displayed in UTC.	2022-11-23T02:27:00Z
RetCode	string	The turned error code. A value of `0` indicates that the task succeeded.	0
Process	string	The progress of the prefetch task, which indicates the number of points of presence (POPs) on which the prefetch task is completed.	100%
Status	string	The status of the task. Valid values: Complete Refreshing Failed	Complete
Urls	object []	The completion details of all URL resources in the task.
Url	string	The URL of the prefetched resource.	/abc.jpg
Success	string	The success percentage, which indicates the number of POPs on which the resource is prefetched.	47%
Description	string	The details of resource prefetch. If the resource is prefetched on all POPs, "Successfully preloaded" is returned. If the resource fails to be prefetched on some POPs, the failure details separated by vertical bars (\|) are returned.	Successfully preloaded

Examples

Sample success responses

JSONformat

{
  "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"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	InvalidTaskId.Malformed	The specified TaskId is invalid.
400	DomainNameOverLimit	A maximum of 500 domains are supported for each request.
400	InvalidTaskId.Malformed	The count of taskIds should be 1.
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

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-03-23

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 429