You can call this operation to prefetch content from an origin server to L2 cache nodes. Consequently, users can directly hit the cache upon their first visits to reduce workloads on the origin server.

When you call this operation, follow these rules:
  • You can submit prefetch requests for a maximum of 500 URLs by using the same account each day.
  • Currently, you cannot prefetch content based on directories.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes PreloadDcdnObjectCaches

The operation that you want to perform. Set the value to PreloadDcdnObjectCaches.

ObjectPath String Yes example.com/image/1.png

The URL of the object to prefetch. You can specify multiple URLs and separate them with line breaks (\n or \r\n).

Area String No domestic

The region of cache nodes where you want to store the prefetched objects. If you do not specify this parameter, prefetched objects are stored in all cache nodes deployed across the world.

  • domestic: mainland China
  • overseas: outside mainland China

Response parameters

Parameter Type Example Description
PreloadTaskId String 95248880

The ID of the pretech task. If multiple tasks are returned, the IDs are separated with commas (,).

RequestId String E5BD4B50-7A02-493A-AE0B-97B9024B4135

The ID of the request.

Examples

Sample requests

https://http://dcdn.aliyuncs.com?&Action=PreloadDcdnObjectCaches
&ObjectPath=test.test.com/test.txt
&<Common request parameters>

Sample success responses

XML format

<PreloadDcdnObjectCachesResponse>
	  <PushTaskId>95248880</PushTaskId>
	  <RequestId>E5BD4B50-7A02-493A-AE0B-97B9024B4135</RequestId>
</PreloadDcdnObjectCachesResponse>

JSON format

{
	"PushTaskId":"95248880",
	"RequestId":"E5BD4B50-7A02-493A-AE0B-97B9024B4135"
}

Error codes

HTTP status code Error code Error message Description
400 SingleRequest.OverLimit A maximum of 1000 URLs are supported for each request. The error message returned because you can only specify a maximum of 1,000 URLs in one request.
400 QuotaExceeded.Preload Your refresh attempts have exceeded the daily limit. The error message returned because your daily objects to prefetch exceeds the upper limit.
400 InvalidObjectPath.Malformed The specified ObjectPath is invalid. The error message returned because the specified ObjectPath parameter is invalid.
400 InvalidExtensiveDomain.ValueNotSupported The specified ExtensiveDomain is not supported. The error message returned because wildcard domains are not supported.
400 PreloadQueueFull The warming queue is full; please try again later. The error message returned because the number of URLs of the objects being prefetched has reached the upper limit. Try again later.

For a list of error codes, visit the API Error Center.