Help Center/ Video On Demand/ API Reference/ Statistical analysis/ Queries statistics on the origin server
Updated on 2024-12-04 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Queries statistics on the origin server

Function

Queries statistics on the VOD origin server, including storage space and transcoded output.

Only historical data of the last month can be queried.

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 start_time and end_time are not specified, set start_time to 00:00:00 on the current day and end_time 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, set end_time to the current time.

  • Only data of 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 to the hour of the specified time and the end time is rounded to the next hour of the specified time.

interval

No

Integer

Query granularity interval

Possible values are:

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

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

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

Unit: second

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

Transcoded file duration.

Unit: minute

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Requests

Queries statistics on the VOD origin server.

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

Example Responses

Status code: 200

The information is returned when the request succeeds.

{
  "start_time" : "20190528000000",
  "interval" : 3600,
  "sample_data" : [ {
    "storage" : 0,
    "transcode" : 0
  } ]
}

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

200

The information is returned when the request succeeds.

400

The information is returned when the request fails.

Error Codes

See Error Codes.

Parent topic: Statistical analysis