Help Center/ Video On Demand/ API Reference/ Media Asset Pre-loading/ Querying CDN Pre-loading Results
Updated on 2025-11-26 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying CDN Pre-loading Results

Function

This API is used to query pre-load results.

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

GET /v1.0/{project_id}/asset/preheating

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

task_id

Yes

String

Task ID.

Request Parameters

Table 3 Request header 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.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

preheating_results

Array of PreheatingResult objects

Pre-load task array.
Table 5 PreheatingResult

Parameter

Type

Description

url

String

Media asset URL.

status

String

Pre-load task status.

The options include:

  • processing: The task is being processed.

  • succeed: The pre-load is complete.

  • failed: The pre-load failed.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

GET https://{endpoint}/v1.0/{project_id}/asset/preheating?task_id={task_id}

Example Responses

Status code: 200

Returned when the request succeeded.

{
  "preheating_results" : [ {
    "url" : "https://example.com/asset/9db42f5e08c15edecd99a98da241994a/313bfd52a75f95ff48e8bf02eca2ab20.flv",
    "status" : "processing"
  }, {
    "url" : "https://example.com/asset/9e455adb02295aa123809e8dc7ca51c1/68b1241af3bf58bcde9914626e07f5af.mp4",
    "status" : "succeed"
  }, {
    "url" : "https://example.com/asset/9e455adb02295aa123809e8dc7ca51c1/play_video/68b1241af3bf58bcde9914626e07f5af_H.264_480X270_HEAACV1_300.mp4",
    "status" : "failed"
  } ]
}

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

200

Returned when the request succeeded.

400

Returned when the request failed.

Error Codes

See Error Codes.

Parent topic: Media Asset Pre-loading