DescribePreloadDetailById API Reference for CDN Prefetch Tasks - CDN

Queries the prefetch progress of a task, including all resources in the task. Only users who are included in the whitelist can use this operation. You can contact your business manager to apply for the whitelist.

Operation description

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cdn:DescribePreloadDetailById

get

*All Resource

*

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	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	array<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.
	array<object>
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	array<object>	The completion details of all URL resources in the task.
	object
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

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.