CDN prefetch
Function
After media files are published, you can call this API to request CDNs for media file pre-loading by ID or URL. Upon the first request, the CDN caches the requested media file for faster download and better user experience. One tenant can pre-load a maximum of 1,000 media files per day.
URI
POST /v1.0/{project_id}/asset/preheating
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token. This parameter is mandatory when token authentication is used. 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 a token. |
Authorization |
No |
String |
Authentication information. This parameter is mandatory for AK/SK authentication. |
X-Sdk-Date |
No |
String |
Time when the request is sent. This parameter is mandatory for AK/SK authentication. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
asset_id |
No |
String |
ID of a published media asset |
urls |
No |
Array of strings |
Streaming URL list of published media assets. A maximum of 10 URLs can be prefetched at a time. |
Response Parameters
Status code: 202
Parameter |
Type |
Description |
---|---|---|
task_id |
String |
Prefetch task ID |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error description |
Example Requests
Prefetch by media ID
POST https://{endpoint}/v1.0/{project_id}/asset/preheating { "asset_id" : "f488337c31c8e4622f1590735b134c65" }
Prefetch by media asset URL
POST https://{endpoint}/v1.0/{project_id}/asset/preheating { "urls" : [ "https://example.com/asset/9db42f5e08c15edecd99a98da241994a/313bfd52a75f95ff48e8bf02eca2ab20.flv", "https://example.com/asset/9e455adb02295aa123809e8dc7ca51c1/68b1241af3bf58bcde9914626e07f5af.mp4", "https://example.com/asset/9e455adb02295aa123809e8dc7ca51c1/play_video/68b1241af3bf58bcde9914626e07f5af_H.264_480X270_HEAACV1_300.mp4" ] }
Example Responses
Status code: 202
The information is returned when the request succeeds.
{ "task_id" : "5199337c31c8e4622f1590735b13a263" }
Status code: 400
The information is returned when the request fails.
{ "error_code" : "VOD.10053", "error_msg" : "The request parameter is illegal, illegal field: {xx}." }
Status Codes
Status Code |
Description |
---|---|
202 |
The information is returned when the request succeeds. |
400 |
The information is returned when the request fails. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackFor any further questions, feel free to contact us through the chatbot.
Chatbot