Help Center/ Video On Demand/ API Reference/ Statistical Analysis/ Querying Origin Server Statistics
Updated on 2026-01-16 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Origin Server Statistics

Function

This API is used to query statistics on VOD origin servers, including the storage space and transcoding output.

Only historical data from the last month can be queried.

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/vod-statistics

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. The format is yyyymmddhhmmss.

end_time

No

String

End time. The format is yyyymmddhhmmss.

  • If neither start_time nor end_time is specified, start_time defaults to 00:00:00 of the current day, and end_time defaults to the current time.

  • If end_time is specified but start_time is not, the request is invalid.

  • If start_time is specified but end_time is not, end_time defaults to the current time.

  • Only data from the past three months can be queried, and the time span cannot exceed 31 days.

  • The start time and end time are automatically rounded. The start time is rounded down to the hour, while the end time is rounded up to the next hour.

interval

No

Integer

Query granularity.

The options include:

  • For a time span of 1 day, the supported granularities are 3,600 seconds (1 hour), 14,400 seconds (4 hours), and 28,800 seconds (8 hours).

  • For a time span of 2 to 7 days, the supported granularities are 3,600 seconds (1 hour), 14,400 seconds (4 hours), 28,800 seconds (8 hours), and 86,400 seconds (1 day).

  • For a time span of 8 to 31 days, the supported granularities are 14,400 seconds (4 hours), 28,800 seconds (8 hours), and 86,400 seconds (1 day).

Unit: seconds

If this parameter is not specified, the minimum granularity for 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 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

start_time

String

Start time for statistics collection.

interval

Integer

Statistics collection interval.

sample_data

Array of VodSampleData objects

Sampled data array. Sampling starts from start_time, and one data record will be collected at each interval (transcoded output unit: min; storage unit: GB).
Table 5 VodSampleData

Parameter

Type

Description

storage

Float

Standard storage space.

Unit: GB

storage_warm

Float

Infrequent Access storage space.

Unit: GB

storage_cold

Float

Archive storage space.

Unit: GB

transcode

Long

Transcoding file duration.

Unit: minutes

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

This example queries VOD origin server statistics.

GET https://{endpoint}/v1.0/{project_id}/asset/vod-statistics?start_time={start_time}

Example Responses

Status code: 200

Returned when the request succeeded.

{
  "start_time" : "20190528000000",
  "interval" : 3600,
  "sample_data" : [ {
    "storage" : 0,
    "transcode" : 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.

Parent topic: Statistical Analysis