DescribeVodMediaPlayData_视频点播_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
  • 目前本接口的服务地址仅支持:华东 2(上海)
  • 仅支持统计使用了阿里云播放器 SDK 的播放数据。
  • 仅支持查询过去 30 天以内的数据。

注意 - 调用本接口之前,需确保阿里云播放器 SDK 满足以下条件:

  • Android 播放器 SDK 或 iOS 播放器 SDK
    • 播放器 SDK 版本为 5.4.9.2 及以上。
    • 已获取播放器 SDK 的 License 授权并接入 License,详情参见 License 管理
    • 已开启播放器 SDK 的埋点日志上报功能,正常情况下,阿里云播放器 SDK 的埋点日志上报功能为默认开启的。更多信息,请参见 Android 端创建播放器iOS 端创建播放器
  • Web 播放器 SDK
    • 播放器 SDK 版本为 2.16.0 及以上。
    • 已申请开通播放质量监控的 License 授权并接入 License,可填写Web 播放器 SDK 增值服务申请表单申请开通,License 接入方法,请参见 Web 端接口说明中的license属性。
    • 已开启播放器 SDK 的埋点日志上报功能,正常情况下,阿里云播放器 SDK 的埋点日志上报功能为默认开启的。

流控信息

请求速率为10/1(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
vod:DescribeVodMediaPlayData
None
全部资源
*

请求参数

字段名称字段详情
PlayDatestring

播放日期,单位:天。格式为:yyyyMMdd。展开详情

示例值:20240322
TerminalTypestring

播放器 SDK 的终端类型。传入此参数,可筛选查询指定终端类型的所有音视频的播放数据。取值:展开详情

示例值:Native
Osstring

播放端的操作系统。传入此参数,可筛选查询指定操作系统的所有音视频的播放数据。取值:展开详情

示例值:Android
Regionstring

服务地域。传入此参数,可筛选查询指定服务地域下的所有音视频的播放数据。取值:展开详情

示例值:cn-beijing
MediaIdstring

媒体 ID,即音/视频 ID(VideoId)。传入此参数,可筛选查询指定媒体 ID 的音视频播放数据,仅支持设置一个媒体 ID。可通过以下方式获取:展开详情

示例值:9ae2af636ca6c10412f44891fc****参考取值来源:
    GetAIMediaAuditJob
    SearchMedia
    RestoreMedia
    SubmitAIMediaAuditJob
    RegisterMedia
    BatchGetMediaInfos
    UpdateAttachedMediaInfos
PageNointeger<int64>

查询数据的当前页码。传入此参数,可指定查询数据从第几页开始返回。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1
PageSizeinteger<int64>

每页显示的数据条数。传入此参数,可设置返回数据每页显示的条数。最大值为 100。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:20
OrderTypestring

排序类型,与OrderName参数搭配使用。传入此参数,可设置返回数据按指定指标的升序或降序进行排列。取值:展开详情

示例值:ASC
OrderNamestring

指标名称,与OrderType参数搭配使用。传入此参数,可设置返回数据按指定指标的升序或降序进行排列。取值:展开详情

示例值:PlaySuccessVv

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:25818875-5F78-4AF6-D7393642CA58****
TotalCountinteger<int64>

返回数据的总条数。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:1
PageNointeger<int64>

返回数据的页码。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:1
PageSizeinteger<int64>

每页显示的数据条数。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:20
QoeInfoListarray<object>

返回数据列表。

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
Meter.ParamError
Param Error:%s,Please Check Again.诊断
403
Meter.AuthError
Authentication Failed,Please Try Again.诊断
500
Meter.ServerInternalError
The Request Processing Has Failed Due To Some Unknown Error.诊断
500
Meter.DataSourceQueryError
Data Source Error:%s,Please Try Again.诊断
502
Meter.ReadyTsError
Get ReadyTs Failed,Please Try Again.诊断

变更历史

变更时间变更内容概要操作
2024-05-07
变更返回参数

相关示例

2024年08月20日