CDN Pre-loading
Function
After a media asset is published, you can call this API to pre-load it to CDN by specifying its ID or URL. When a user requests the asset for the first time, CDN serves the content directly, reducing cache warm-up latency and improving user experience. One tenant can pre-load a maximum of 1,000 media assets per day.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.
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 the user token. |
|
Authorization |
No |
String |
Authentication information. This parameter is mandatory for AK/SK authentication. |
|
X-Sdk-Date |
No |
String |
Time when a 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 preloaded at a time. |
Response Parameters
Status code: 202
|
Parameter |
Type |
Description |
|---|---|---|
|
task_id |
String |
Pre-load task ID. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error description. |
Example Requests
-
This example pre-loads media asset by media asset ID.
POST https://{endpoint}/v1.0/{project_id}/asset/preheating Content-Type: application/json { "asset_id": "f488337c31c8e4622f1590735b134c65" } -
This example pre-loads media assets by media asset URL.
POST https://{endpoint}/v1.0/{project_id}/asset/preheating Content-Type: application/json{ "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
Returned when the request succeeded.
{
"task_id" : "5199337c31c8e4622f1590735b13a263"
}
Status code: 400
Returned when the request failed.
{
"error_code" : "VOD.10053",
"error_msg" : "The request parameter is illegal, illegal field: {xx}."
}
Status Codes
|
Status Code |
Description |
|---|---|
|
202 |
Returned when the request succeeded. |
|
400 |
Returned when the request failed. |
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