更新时间:2024-11-20 GMT+08:00
分享

查询TopN媒资信息

功能介绍

查询指定域名在指定日期播放次数排名Top 100的媒资统计数据。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v1.0/{project_id}/asset/top-statistics

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

domain

String

查询域名,暂只支持查询单个或者全部域名。

取值如下:

  • 单个加速域名,格式:example.test1.com。

  • ALL:表示查询名下全部域名。

date

String

查询日期,格式为yyyymmdd

  • date必须为昨天或之前的日期。

  • 最多只能查最近一个月内的数据。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,使用Token鉴权方式时必选。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Authorization

String

使用AK/SK方式认证时必选,携带的鉴权信息。

X-Sdk-Date

String

使用AK/SK方式认证时必选,请求的发生时间。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

top_urls

Array of TopUrl objects

指定域名top100 URL集合

表5 TopUrl

参数

参数类型

描述

value

Long

总播放次数。

asset_id

String

VOD分配的媒资ID,仅支持查询,不支持修改。

title

String

媒资名称。

duration

Integer

媒资时长。

单位:秒。

duration_ms

Long

视频时长,单位毫秒。

size

Long

媒资原始大小。

单位:字节。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

查询top100

GET https://{endpoint}/v1.0/{project_id}/asset/top-statistics?domain=ALL&date=20190612

响应示例

状态码: 200

处理成功返回。

{
  "top_urls" : [ {
    "value" : 0,
    "asset_id" : "548b6023bf2cc925bd64343f04ca0f88",
    "title" : "test",
    "duration" : 0,
    "duration_ms" : 0,
    "size" : 0
  } ]
}

状态码: 400

处理失败返回。

{
  "error_code" : "VOD.10053",
  "error_msg" : "The request parameter is illegal, illegal field: {xx}."
}

状态码

状态码

描述

200

处理成功返回。

400

处理失败返回。

错误码

请参见错误码

相关文档