Help Center/ Video On Demand/ API Reference/ Statistical Analysis/ Querying Playback Logs of a Domain Name
Updated on 2026-02-27 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Playback Logs of a Domain Name

Function

This API is used to query CDN logs of a specified VOD domain name in a specified period.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    vod:log:get

    Read

    -

    -

    -

    -

URI

GET /v1.0/{project_id}/vod/cdn/logs

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

domain_name

Yes

String

Acceleration domain name, for example, www.test1.com.

query_date

Yes

String

Query start time. The format is yyyyMMddHHmmss.

  • The query result is log data generated within 24 hours after the start time.

  • You can query data from the past month.

page_size

No

Integer

Number of logs displayed on each page. The value ranges from 1 to 10,000 (default value).

page_number

No

Integer

Current page. The value ranges from 1 (default value) to 65,535.

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

total

Integer

Total number of logs.

logs

Array of CdnLog objects

Log list.
Table 5 CdnLog

Parameter

Type

Description

domain_name

String

Domain name.

start_time

String

Query start time.

end_time

String

Query end time.

name

String

Log name.

size

Long

Log size.

Unit: bytes

link

String

Link for downloading the log file.

For the description of the fields in the log file, see Log Management.

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

GET https://{endpoint}/v1.0/{project_id}/vod/cdn/logs?domain_name=1866.cdn-vod.huaweicloud.com&query_date=20211223000000

Example Responses

Status code: 200

Returned when the request succeeded.

{
  "total" : 1,
  "logs" : [ {
    "domain_name" : "1866.cdn-vod.huaweicloud.com",
    "start_time" : "2021-12-23 23:00:00",
    "end_time" : "2021-12-24 00:00:00",
    "name" : "2021122323-1866.cdn-vod.huaweicloud.com-cn.gz",
    "size" : 225,
    "link" : "http://cdn-log-user-bj4.obs.cn-north-4.myhuaweicloud.com:80/mainland/20211223/23/2021122323-1866.cdn-vod.huaweicloud.com-cn.gz?AccessKeyId=AOV5GWALBMNTLIYDEQLV&Expires=1641433717&response-content-disposition=attachment%3Bfilename%3D%222021122323-1866.cdn-vod.huaweicloud.com-cn.gz%22&Signature=kZYh0hEos2V**********AHGyXA%3D"
  } ]
}

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