查询主播推拉流实时信息接口

最近更新时间:2020-05-27 20:55:48

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

接口描述

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

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

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

2.主播热度信息(拉流信息汇合)

  • 主播在线人数:即原流和各转码流拉流在线人数的和值
  • 主播拉流带宽:即原流和各转码流拉流带宽的和值

3.各码率观看热度(各路拉流信息)

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

备注:

  • 推流质量信息为查询时刻的瞬时信息,因数据统计汇总,拉流数据会有5-10min的延时

  • 此接口不适合高频度调用,每个UID限制访问频率300次/分钟

请求参数

参数名 类型 是否必须 描述
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 推流流名,直播推流rtmp://pubdomain.xxx.com/live/ 123中的123
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"
    }
}

金山云,开启您的云计算之旅

免费注册