Help Center/ Video On Demand/ API Reference/ Media file pre-loading/ Queries information of CDN prefetch
Updated on 2024-03-01 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Queries information of CDN prefetch

Function

Queries the prefetch result

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 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.

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

preheating_results

Array of PreheatingResult objects

Prefetch task array
Table 5 PreheatingResult

Parameter

Type

Description

url

String

Media asset URL

status

String

Pre-loading task status

Possible values are:

  • processing: The task is being processed.

  • succeed: The pre-loading is complete.

  • failed: The pre-loading 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: 202

The information is returned when the request succeeds.

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

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.

Parent topic: Media file pre-loading