全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

查询主播推拉流信息接口

最近更新时间:2021-11-30 20:32:49

查询主播推拉流信息接口(ListRealtimeStreamsInfo)

接口说明

此接口汇总了主播的实时推流质量状态、主播热度和各码率观看热度

1.主播推流质量状态信息

  • 推流列表:查询时间点的瞬时在推流名列表
  • 质量信息:码率、帧率、丢帧率、客户端IP,CDN收流节点IP等

2.主播热度信息(注意:此接口不能用来查询推流触发转码的主播热度信息,即统计的在线人数和带宽不包括推流转码的转码流数据,如需全量查询带宽、人数请参考GetLivePlayStatData

  • 观众在线人数:即原流和各转码流观众在线人数的加和
  • 观众拉流带宽:即原流和各转码流拉流带宽的加和

3.各码率观看热度(注意:此接口不能用来查询推流触发转码的转码流信息,即统计的流名列表、在线人数、拉流带宽不包括推流转码的转码流数据,如需全量查询带宽、人数请参考GetLivePlayStatData

  • 各码率拉流流名列表:包含原流名和转码后的流名
  • 在线人数:返回原流/转码流的在线人数
  • 拉流带宽:返回原流/转码流的带宽

注意:

  • 在线人数及带宽目前支持查询的地区:中国大陆
  • 推流质量信息为查询时刻的瞬时信息,因数据统计汇总,拉流数据会有5-10min的延时
  • 限制访问频率:50次/分钟
  • 数据粒度:1min
  • 单次返回数据最多10000条,如需增加数据量请联系售后评估
  • 调用方式:HTTP POST

请求参数

参数名 类型 是否必须 描述
Action String Y 查询主播推拉流实时信息接口(ListRealtimeStreamsInfo)
Version String Y 版本号,取值:2017-01-01
UniqueName String Y 域名空间
App String Y 应用名
Stream String N 流名,只支持输入单个流名
DomainIds String N 拉流域名ID,缺省为UniqueName下全部拉流域名,可输入需要查询的拉流域名ID,支持批量域名查询,多个域名ID用逗号(半角)分隔
PullProtocol String N 返回拉流信息协议类型,默认http+flv,http flv协议在线人数和带宽;rtmp,rtmp协议在线人数和带宽;hls:返回hls协议在线人数和带宽
Type String N 返回信息类型, 缺省:返回推拉流信息的交集,push,只返回推流信息,pull:只返回拉流信息

返回参数

参数名 类型 描述
UniqueName String 域名空间
App String 应用名
Count Int 在线主播数/人
Bw Long 所有主播的观众拉流带宽加和/bps,如果输入流名查询,则查询单主播的观众拉流带宽
OnlineUser Long 所有主播的在线观众数量,如果输入流名查询,则查询单主播的在线观众数量
RetCode Int 响应码 0成功 其他失败
RetMsg String 响应信息描述
Streams DataByStream[] 在线主播列表(不包含查询时间点在推流)

DataByStream

参数名 类型 描述
Stream String 推流流名
ClientIP String 推流客户端IP
Node String CDN收流节点IP
PubTime Int 开始推流的UTC时间,10位UTC时间戳
FrameRate Int 视频理论帧率/fps
Curfps Int 视频真实帧率/fps
FLR Int 丢帧率/%=(1-帧率/原始帧率)*100%
Curbitrate Double 视频码率/kbps
BwInAudio Double 音频码率/kbps
BwIn Double 理论码率/kbps=视频码率+音频码率
BwReal Double 真实码率/kbps,即推流传输码率
BwDiff Double 码率差值/kbps=理论码率-真实码率
Width Int 视频宽度/P
Height Int 视频高度/P
SampleRate Int 音频采样率/Hz
Vcodec String 视频编码格式
Acodec String 音频编码格式
OnlineUser Long 主播在线人数/人,原流名+所有转码流的在线人数
Bw Long 主播拉流带宽/bps,原流名+所有转码流的拉流带宽
Pulls DataByPull[] 在线主播列表(不包含查询时间点在推流)

DataByPull

参数名 类型 描述
Stream String 拉流流名,包括原流名拉流,转码拉流流名
OnlineUser Long 在线人数/人
Bw Long 带宽/bps

请求示例

POST /?Action=ListRealtimeStreamsInfo&Version=2017-01-01 HTTP/1.1 
Content-Type: application/json
X-Amz-Date: YOURDATE
Authorization: AWS4-HMAC-SHA256 Credential=YOURAK/YYYYMMDD/cn-beijing-6/kls/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature=SIG
Host: kls.api.ksyun.com

{ 
    "UniqueName":"xxx",
     "App":"xx"
}

返回示例

{
    "Data":
  {
        "UniqueName":"xxx",
        "App":"live",
        "Bw":50000,
        "OnlineUser":500,
        "Count":1,
        "Streams":[
            {
                "Node":"xxxxx",
                "FLR": 52,
                "BwDiff": 555.5,
                "Vcodec": "h264",
                "Acodec": "mp3",
                "OnlineUser": 500 ,
                "Bw": 50000 ,
                "BwInAudio": 21043,
                "BwIn": 442409,
                "BwReal": 223,
                "BwDiff": 442186,
                "Width": 368,
                "Clientip":"114.255.44.132",
                "Curbitrate":52666,
                "Curfps":31,
                "FrameRate": 30 ,
                "Height": 614 ,
                "Pubtime":1491033051,
                "SampleRate": 44100 ,
                "Stream":"s222"
                "Pulls":[
                    {
                        "Stream":"s222",
                        "Bw":"20000",
                        "OnlineUser": 200 
                    },
                    {
                        "Stream":"s222_1500",
                        "Bw": 30000 ,
                        "OnlineUser": 300 
                    }
                ]
            },
            {

            }
        ],
        "RetCode":0,
        "RetMsg":"success"
  }
}

错误码

为了帮您快速定位问题,云直播将错误码集中归类,请到错误码中心查看详情。

文档导读
纯净模式常规模式

纯净模式

点击可全屏预览文档内容
文档反馈