DescribeLiveUserStreamMetricData - 查询指定域名流粒度批量数据

用于查询指定加速域名下的流粒度批量数据,支持多种协议。

接口说明

说明

暂不支持 HLS 协议新建连接数查询,HLS 在线人数按照默认格式的请求进行统计,特殊格式的请求需提交工单进行配置。默认格式如下:

  • m3u8 请求示例:http(s)://example.aliyundoc.com/Appname/ StreamName.m3u8

  • ts 请求示例:http(s)://example.aliyundoc.com/Appname/ StreamName/153xxxxxxxx_137xxxxx.ts

请求说明

  • 单次查询限制:单次查询最多返回 5000 行数据。

  • 域名查询限制:仅支持单个域名查询,多个域名会报错。

  • 时间跨度限制:数据最大查询跨度为 24 小时。

  • 时间粒度限制:数据最小查询粒度为 1 分钟。

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

  • 调用频率限制:单用户调用频率为 10 次/秒。

  • 特殊参数组合:当DomainName不为空且AppNameStreamName都设置为all时,将返回加速域名下的聚合数据。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

live:DescribeLiveUserStreamMetricData

none

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

DomainName

string

需要查询的加速域名。

说明

仅支持单个域名查询,传多个域名将报错。域名为空时,查询用户下的所有加速域名的聚合数据。不指定 AppNameStreamName 时,按域名返回所有流粒度的数据。

test.com

StartTime

string

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

2015-12-10T20:00:00Z

EndTime

string

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

2015-12-10T21:00:00Z

AppName

string

应用名称。指定应用名称,查询对应应用流粒度的数据;指定 StreamName 时,必须指定 AppName

app

StreamName

string

流名称。指定 StreamName 时,按指定 AppName 的指定 StreamName,返回流粒度的数据(指定 StreamName 时,必须指定 AppName)。

test.flv

Protocol

string

流协议名。指定流协议名查询流对应协议的数据,目前支持:flv, hls, rtmp, rts, p2p。支持查询多个协议的数据,协议间用 , 分隔,多个协议的数据不会聚合,按照流的粒度输出。

说明

rts 选项可查询 artc 协议的超低延时直播流。

  • 使用 rts 可能需要额外统计 xxx_AliRTS-opu 转码流。原因:Web 端播超低延时直播时,会生成流名后加上_AliRTS-opus 后缀的转码流进行自动转码,产生转码流数据。详细请参见 rts 亚秒延时自动转码

flv

PageNumber

integer

当前页码。

1

PageSize

integer

单页数据条数,单页最大 5000

10

返回参数

名称

类型

描述

示例值

object

Schema of Response

DomainName

string

加速域名信息

test.com

EndTime

string

YYYY-MM-DDThh:mm:ssZ

2015-12-10T21:00:00Z

PageSize

integer

每页显示的条数。

10

RequestId

string

请求 ID。

16A96B9A-F203-4EC5-8E43-CB92E68F****

StartTime

string

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

2015-12-10T20:00:00Z

StreamDetailData

array<object>

每个时间间隔的流量数据

object

返回数据组。

AppName

string

应用名称,无论是否指定均返回该值

app

Bps

number

流每分钟总带宽,单位bps

423304182.66

Count

integer

流每分钟总在线人数

423304182

FlvBps

number

flv 协议带宽,单位 bps (指定协议不满足时,不返回)

454

FlvCount

integer

flv 协议在线人数(指定协议不满足时,不返回)

32

FlvTraffic

number

flv 协议流量,单位 byte (指定协议不满足时,不返回)

1254

HlsBps

number

hls 协议带宽,单位 bps (指定协议不满足时,不返回)

4456

HlsCount

integer

hls 协议在线人数 (指定协议不满足时,不返回)

56

HlsTraffic

number

hls 协议流量,单位 byte (指定协议不满足时,不返回)

568

NewConns

integer

流每分钟新建连接数

450

P2pBps

number

p2p 协议带宽,单位 bps (指定协议不满足时,不返回)

6845

P2pCount

integer

p2p 协议在线人数 (指定协议不满足时,不返回)

78

P2pTraffic

number

p2p 协议流量,单位 byte (指定协议不满足时,不返回)

4102

RtmpBps

number

rtmp 协议带宽,单位 bps (指定协议不满足时,不返回)

3323

RtmpCount

integer

rtmp 协议在线人数(指定协议不满足时,不返回)

63

RtmpTraffic

number

rtmp 协议流量,单位 byte (指定协议不满足时,不返回)

5568

RtsBps

number

rts 协议带宽,单位 bps (指定协议不满足时,不返回)

2361

RtsCount

integer

rts 协议在线人数 (指定协议不满足时,不返回)

89

RtsTraffic

number

rts 协议流量,单位 byte (指定协议不满足时,不返回)

2322

StreamName

string

流名称,无论是否指定均返回该值

test.flv

TimeStamp

string

时间片起始时刻

2015-12-10T20:00:00Z

Traffic

number

流每分钟总流量,单位 byte

423304182

TotalCount

integer

总条数

50

PageNumber

integer

页码

1

示例

正常返回示例

JSON格式

{
  "DomainName": "test.com",
  "EndTime": "2015-12-10T21:00:00Z",
  "PageSize": 10,
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F****",
  "StartTime": "2015-12-10T20:00:00Z",
  "StreamDetailData": [
    {
      "AppName": "app",
      "Bps": 423304182.66,
      "Count": 423304182,
      "FlvBps": 454,
      "FlvCount": 32,
      "FlvTraffic": 1254,
      "HlsBps": 4456,
      "HlsCount": 56,
      "HlsTraffic": 568,
      "NewConns": 450,
      "P2pBps": 6845,
      "P2pCount": 78,
      "P2pTraffic": 4102,
      "RtmpBps": 3323,
      "RtmpCount": 63,
      "RtmpTraffic": 5568,
      "RtsBps": 2361,
      "RtsCount": 89,
      "RtsTraffic": 2322,
      "StreamName": "test.flv",
      "TimeStamp": "2015-12-10T20:00:00Z",
      "Traffic": 423304182
    }
  ],
  "TotalCount": 50,
  "PageNumber": 1
}

错误码

HTTP status code

错误码

错误信息

描述

400 Meter.ParamError Param Error:%s,Please Check Again. 报错信息
500 Meter.ServerInternalError The Request Processing Has Failed Due To Some Unknown Error. 服务内部异常
500 Meter.DataSourceQueryError Data Source Error:%s,Please Try Again. 数据查询错误
403 Meter.AuthError Authentication Failed,Please Try Again. 鉴权失败
502 Meter.ReadyTsError Get ReadyTs Failed,Please Try Again. 查询的数据还未就绪

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情