Help Center/ Video On Demand/ API Reference/ Media Asset Storage Mode Management/ Querying Retrieved Data
Updated on 2025-03-25 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Retrieved Data

Function

Typical Scenarios

Used to query the statistics about data volume whose storage class is changed from Infrequent Access or Archive to Standard

Functions

Used to query the statistics about data volume whose storage class is changed from Infrequent Access or Archive to Standard

URI

GET /v1/{project_id}/asset/vod-retrieval

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

start_time

No

String

Start time

end_time

No

String

End time

interval

No

Integer

Sampling interval, in second. Options:

For a time span of 1 day, the sampling intervals 1 hour, 4 hours, and 8 hours correspond to 3,600s, 14,400s, and 28,800s, respectively.

For a time span of 2 to 7 days, the sampling intervals 1 hour, 4 hours, 8 hours, and 1 day correspond to 3,600s, 14,400s, 28,800s, and 86,400s, respectively.

For a time span of 8 to 31 days, the sampling intervals 4 hours, 8 hours, and 1 day correspond to 14,400s, 28,800s, and 86,400s, respectively.

If this parameter is not specified, the minimum interval of the corresponding time span is used by default.

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: 200

Table 4 Response body parameters

Parameter

Type

Description

start_time

String

Start time for statistics collection

interval

Integer

Sampling interval

sample_data

Array of VodRetrievalData objects
Table 5 VodRetrievalData

Parameter

Type

Description

retrieval_warm

Double

Size of the media files whose storage class is changed from Infrequent Access to Standard.

retrieval_cold

Double

Size of the media files that change the storage class from Archive to Standard using the standard retrieval mode.

retrieval_cold_speed

Double

Size of the media files that change the storage class from Archive to Standard using the quick retrieval mode.

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/{project_id}/asset/vod-retrieval

Example Responses

Status code: 200

Returned when the request succeeded.

{
  "start_time" : "20240615000000",
  "interval" : 3600,
  "sample_data" : [ {
    "retrieval_warm" : 1.88,
    "retrieval_cold" : 2.4,
    "retrieval_cold_speed" : 1.9
  }, {
    "retrieval_warm" : 3.6,
    "retrieval_cold" : 4.6,
    "retrieval_cold_speed" : 3.56
  }, {
    "retrieval_warm" : 2.5,
    "retrieval_cold" : 0,
    "retrieval_cold_speed" : 0.08
  }, {
    "retrieval_warm" : 0,
    "retrieval_cold" : 0,
    "retrieval_cold_speed" : 0
  } ]
}

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.