DescribeLiveStreamMetricDetailData_视频直播_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.

接口说明

若指定域名第一次使用此接口进行流粒度数据的查询,需先提交工单进行后端配置后方可使用。 请在工单中提供如下信息:

  • 需要查询的域名。
  • 对应域名下最高并发直播流数。
  • 每个直播流最高并发在线人数。
说明 提交工单申请后预计在一个工作日内完成审核。

使用限制

  • 默认不支持 HLS 的在线人数统计。

  • 仅支持单个域名查询。

  • 数据最大查询跨度:24 小时。

  • 数据最小查询粒度:1 分钟。

  • 数据最大查询范围:31 天。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

流控信息

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

授权信息

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

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
live:DescribeLiveStreamMetricDetailData
None
Domain
acs:cdn:*:{#accountId}:domain/{#DomainName}

请求参数

字段名称字段详情
DomainNamestring
  • 需要查询的加速域名。仅支持单个域名查询,传多个域名将报错。展开详情
示例值:example.com参考取值来源:
    AddLiveDomain
    DescribeDomainUsageData
    ListLiveRealtimeLogDeliveryDomains
StartTimestring

获取数据起始时间点,日期格式按照 ISO8601 表示法,并使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。

示例值:2015-12-10T20:00:00Z
EndTimestring

结束时间需大于起始时间,不能相差超过 1 天;日期格式按照 ISO8601 表示法,并使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。

示例值:2015-12-10T21:00:00Z
AppNamestring

应用名称,查询指定应用流粒度的数据。展开详情

示例值:liveApp****参考取值来源:
    GetMessageApp
    ListMessageApp
    QueryMessageApp
    CreateMessageApp
StreamNamestring

流名称,按照设置的 AppName 指定 StreamName,返回流粒度的数据。展开详情

示例值:liveStream****参考取值来源:
    AddLiveStreamMerge
    DescribeMixStreamList
    QueryLiveDomainMultiStreamList
Protocolstring

流协议名,目前支持:flvhlsrtmprtsp2p展开详情

示例值:flv
NextPageTokenstring

分页查询 token,每次查询最多返回 5000 行数据,当要查询的数据超过 5000 行时,响应数据会提供下次查询数据的起始索引。请求时传入该 token,将从上一次查询结束的下一行继续查询未获取的数据。

示例值:UjsM9x3aVcJi9a0-ArwJUTTC67CIBKLw*****

返回参数

字段名称字段详情
DomainNamestring

查询的加速域名。

示例值:example.com
EndTimestring

结束时间。

示例值:2015-12-10T21:00:00Z
NextPageTokenstring

下一次返回数据的起始索引,当查询的数据未获取完时返回该值。

示例值:UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=
PageSizeinteger<int32>

返回数据行数。

示例值:5000
RequestIdstring

请求 ID。

示例值:B955107D-E658-4E77-B913-E0AC3D31693E
StartTimestring

开始时间。

示例值:2015-12-10T20:00:00Z
StreamDetailDataobject

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
InvalidStartTime.Malformed
Specified StartTime is malformed.诊断
400
InvalidEndTime.Malformed
Specified EndTime is malformed.诊断
400
InvalidEndTime.Mismatch
Specified end time does not math the specified start time.诊断
400
InvalidTimeSpan
The time span exceeds the limit.诊断
400
InvalidPageToken
The token of page is invalid.诊断
400
InvalidAppName.Mismatch
The AppName param must be passed.诊断
400
InvalidStreamProtocol.NotSupport
The specified stream protocol is not support.诊断
400
InvalidStreamName.LengthTooLong
The specified stream name is too long.诊断
400
InvalidAppName.LengthTooLong
The specified app name is too long.诊断
400
InvalidTime.ValueNotSupported
Specified Time is malformed.诊断

变更历史

变更时间变更内容概要操作
2023-12-21
变更错误码400
变更请求参数DomainName
变更返回参数

相关示例