全部产品
Search

搜索本产品

    视频直播：DescribeLiveStreamMetricDetailData - 查询指定域名流粒度批量数据

    文档中心

    视频直播：DescribeLiveStreamMetricDetailData - 查询指定域名流粒度批量数据

    更新时间：Dec 05, 2024

    调用DescribeLiveStreamMetricDetailData查询指定域名流粒度批量数据，单次查询最多返回5000行数据。

    接口说明

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

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

    使用限制

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

    • 仅支持单个域名查询。

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

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

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

    QPS 限制

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

    调试

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

    授权信息

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

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    live:DescribeLiveStreamMetricDetailDatanone
    *Domain
    acs:cdn:*:{#accountId}:domain/{#DomainName}
      无
    		无

    请求参数

    名称类型必填描述示例值
    DomainNamestring否
    • 需要查询的加速域名。仅支持单个域名查询，传多个域名将报错。
    • 不指定 AppName 和 StreamName 时，按域名返回所有流粒度的数据。
    • 域名为空时，查询用户下的所有加速域名的聚合数据
    • DomainName 不为空且 AppName 为 all 和 StreamName 为 all 时，返回指定加速域名下的聚合数据。
    		example.com
    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否

    应用名称，查询指定应用流粒度的数据。

    说明 指定 StreamName 时，必须指定 AppName。
    		liveApp****
    StreamNamestring否

    流名称，按照设置的 AppName 指定 StreamName，返回流粒度的数据。

    说明 指定 StreamName 时，必须指定 AppName。
    		liveStream****
    Protocolstring否

    流协议名，目前支持：flv、hls、rtmp、rts 和 p2p。

    支持查询多个协议的数据，不同协议之间用英文逗号（,）分隔。但多个协议的数据不会聚合，按照流的粒度输出。

    		flv
    NextPageTokenstring否

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

    		UjsM9x3aVcJi9a0-ArwJUTTC67CIBKLw*****

    返回参数

    名称类型描述示例值
    object

    查询数据。

    DomainNamestring

    查询的加速域名。

    		example.com
    EndTimestring

    结束时间。

    		2015-12-10T21:00:00Z
    NextPageTokenstring

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

    		UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=
    PageSizeinteger

    返回数据行数。

    		5000
    RequestIdstring

    请求 ID。

    		B955107D-E658-4E77-B913-E0AC3D31693E
    StartTimestring

    开始时间。

    		2015-12-10T20:00:00Z
    StreamDetailDataarray<object>

    返回数据组。

    StreamDataobject

    返回数据组。

    AppNamestring

    应用名称。

    		app
    Bpsfloat

    流每分钟平均带宽，单位：bps。

    		423304182.66
    Countlong

    流每分钟总在线人数。

    		423304182
    FlvBpsfloat

    FLV 协议带宽，单位：bps。

    说明 指定协议不满足时，不返回。
    		454
    FlvCountlong

    FLV 协议在线人数。

    说明 指定协议不满足时，不返回。
    		32
    FlvTrafficlong

    FLV 协议流量，单位：Byte。

    说明 指定协议不满足时，不返回。
    		1254
    HlsBpsfloat

    HLS 协议带宽，单位：bps。

    说明 指定协议不满足时，不返回。
    		4456
    HlsCountlong

    HLS 协议在线人数。

    说明 指定协议不满足时，不返回。
    		56
    HlsTrafficlong

    HLS 协议流量，单位：Byte。

    说明 指定协议不满足时，不返回。
    		568
    NewConnsstring

    流每分钟新建连接数。

    		450
    P2pBpsfloat

    P2P 协议带宽，单位：bps。

    说明 指定协议不满足时，不返回.
    		6845
    P2pCountlong

    P2P 协议在线人数。

    说明 指定协议不满足时，不返回。
    		78
    P2pTrafficlong

    P2P 协议流量，单位：Byte。

    说明 指定协议不满足时，不返回。
    		4102
    RtmpBpsfloat

    RTMP 协议带宽，单位：bps。

    说明 指定协议不满足时，不返回。
    		3323
    RtmpCountlong

    RTMP 协议在线人数。

    说明 指定协议不满足时，不返回。
    		63
    RtmpTrafficlong

    RTMP 协议流量，单位：Byte。

    说明 指定协议不满足时，不返回。
    		5568
    RtsBpsfloat

    RTS 协议带宽，单位：bps。

    说明 指定协议不满足时，不返回。
    		2361
    RtsCountlong

    RTS 协议在线人数。

    说明 指定协议不满足时，不返回。
    		89
    RtsTrafficlong

    RTS 协议流量，单位：Byte。

    说明 指定协议不满足时，不返回。
    		2322
    StreamNamestring

    流名称。

    		test.flv
    TimeStampstring

    时间片起始时刻。

    		2015-12-10T20:00:00Z
    Trafficlong

    流每分钟总流量，单位：Byte。

    		423304182

    示例

    正常返回示例

    JSON格式

    {
  "DomainName": "example.com",
  "EndTime": "2015-12-10T21:00:00Z",
  "NextPageToken": "UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=",
  "PageSize": 5000,
  "RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
  "StartTime": "2015-12-10T20:00:00Z",
  "StreamDetailData": {
    "StreamData": [
      {
        "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
      }
    ]
  }
}

    错误码

    HTTP status code错误码错误信息描述
    400InvalidStartTime.MalformedSpecified StartTime is malformed.StartTime参数错误，请您确认该StartTime参数是否正确。
    400InvalidEndTime.MalformedSpecified EndTime is malformed.结束时间错误，请您确认结束时间是否正确。
    400InvalidEndTime.MismatchSpecified end time does not math the specified start time.结束时间与开始时间不匹配，请您确认时间的匹配度。
    400InvalidTimeSpanThe time span exceeds the limit.时间跨度超过限制，请参照接口文档，配置合理查询跨度。
    400InvalidPageTokenThe token of page is invalid.指定的分页token错误，请传入上次查询返回的正确索引，并确认没有修改您的请求参数。
    400InvalidAppName.MismatchThe AppName param must be passed.AppName参数不匹配，请确认传入了正确的AppName参数。
    400InvalidStreamProtocol.NotSupportThe specified stream protocol is not support.指定的流协议不支持，请参照文档查询所需的流协议。
    400InvalidStreamName.LengthTooLongThe specified stream name is too long.StreamName的长度超过限制，请传入合法的StreamName。
    400InvalidAppName.LengthTooLongThe specified app name is too long.AppName的长度超过限制，请传入合法的AppName。
    400InvalidTime.ValueNotSupportedSpecified Time is malformed.指定的时间无效。

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

    变更历史

    变更时间变更内容概要操作
    2023-12-21OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
    2023-03-14OpenAPI 错误码发生变更查看变更详情