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

Size: px

Start display at page:

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

崩褚
4 years ago
Views:

1 目录目录目录查询主播推拉流实时信息接口 (ListRealtimeStreamsInfo) 接口请求参数返回参数请求示例返回示例查询推流实时信息接口 (ListRealtimePubStreamsInfo) 接口请求参数返回参数请求示例返回示例 Postman 调用示例查询流历史信息接口 (ListHistoryPubStreamsInfo) 接口说明请求参数返回参数请求示例返回示例查询流历史错误信息接口 (ListHistoryPubStreamsErrInfo) 接口请求参数返回参数请求示例返回示例查询主播流时长接口 (ListStreamDurations ) 请求参数返回参数请求示例返回示例金山云 1/15

2 查询主播推拉流实时信息接口 (List Realt imes t reamsin fo) 接口此接口汇总了主播的实时推流质量状态主播热度和各码率观看热度 1. 主播推流质量状态信息推流列表 : 查询时间点的瞬时在推流名列表质量信息 : 码率帧率丢帧率客户端 IP,CDN 收流节点 IP 等 2. 主播热度信息 ( 拉流信息汇合 ) 主播在线人数 : 即原流和各转码流拉流在线人数的和值主播拉流带宽 : 即原流和各转码流拉流带宽的和值 3. 各码率观看热度 ( 各路拉流信息 ) 各码率拉流流名列表 : 包含原流名和转码后的流名 ; 在线人数 : 返回原流 / 转码流的在线人数拉流带宽 : 返回原流 / 转码流的带宽注 : 推流质量信息为查询时刻的瞬时信息, 因数据统计汇总, 拉流数据会有 5-10min 的延时请求参数是否必须 Action String Y 查询主播推拉流实时信息接口 (ListRealtimeStreamsInfo) Versio n UniqueN ame String Y 版本号, 取值 : string Y 域名标识 App string Y 应用名 Stream string N 流名, 只支持输入单个流名 Domain Ids String N 拉流域名 ID, 缺省为 UniqueName 下全部拉流域名, 可输入需要查询的拉流域名 ID, 支持批量域名查询, 多个域名 ID 用逗号 ( 半角 ) 分隔 PullPr otocol String N 返回拉流信息协议, 默认 http+ f l v:http f l v 协议在线人数和带宽,rtm p:r tm p 协议在线人数和带宽 ;hl s: 返回 hl s 协议在线人数和带宽 ;a l l : 返回所有协议和带宽和值 Type String N 返回信息, 默认 all: 推拉流信息全部返回,push, 只返回推流信息,pull: 只返回拉流信息返回参数金山云 2/15

3 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 金山云 3/15

4 Stream String 拉流流名, 包括原流名拉流, 转码拉流流名 OnlineUser Long 在线人数 / 人 Bw Long 带宽 /bps 请求示例 POST api/listrealtimestreamsinfo/ Host: kls.api.ksyun.com Content-Type: application/json "UniqueName":"xxx", "App":"xx" 返回示例金山云 4/15

5 "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": , "BwReal": 223, "BwDiff": , "Width": 368, "Clientip":" ", "Curbitrate":52666, "Curfps":31, "FrameRate": 30, "Height": 614, "Pubtime": , "SampleRate": 44100, "Stream":"s222" "Pulls":[ "Stream":"s222", "Bw":"20000", "OnlineUser": 200, "Stream":"s222_1500", "Bw": 30000, "OnlineUser": 300 ], "RetCode":0, "RetMsg":"success" 查询推流实时信息接口 (List Realt imepu b S t reamsin fo) 接口此接口用于查询 Pubdomain 或者单路流 stream 下实时流信息金山云 5/15

6 请求参数是否必须 Action String Y 操作接口名, 取值 :ListRealtimePubStreamsInfo Version String Y 版本号, 取值 : UniqueName string Y 域名标识 App string Y 应用名 Pubdomain string Y 推流域名 Stream string N 流名 OrderTime int N 排序 (0: 从最新的开始,1: 从后向前 ), 默认为 0 Marker int N 起始游标, 默认为 0 Limit int N 单次请求返回配置数量限制, 默认 1000 返回参数 UniqueName string 域名标识 App string 应用名 Pubdomain string 推流域名 Stream string 流名 Count int 返回记录数 Marker int 起始游标, 默认为 0 OrderTime int 排序,0: 从最新的录制任务开始,1: 从后向前 Total int 记录总数 ClientIP String 推流客户端 IP Width string 视频宽度 Height string 视频高度 FrameRate string 视频理论帧率 Curfps int 视频实时帧率 Curbitrate int 视频码率 /B BwInAudio string 音频码率 /B SampleRate string 音频采样率 /Hz BwReal string 总真实码率 /kb BwIn string 总理论码率 /kb UpdateTime int 流信息采集 UTC 时间金山云 6/15

7 PubTime int 开始推流的 UTC 时间 RetCode int 响应码 0 成功其他失败 RetMsg string 错误信息请求示例 omain=xxx.xxx.com&marker=0&limit=2&ordertime=0 返回示例 "Data": "App": "live", "Count": 1, "Marker": 0, "OrderTime": 0, "Pubdomain": "xxx.xxx.com", "Result": [ "BwIn": "52666", "BwInAudio": "20814", "BwReal": "52227", "Clientip": " ", "Curbitrate": 52666, "Curfps": 31, "FrameRate": "30", "Height": "614", "Pubtime": , "SampleRate": "44100", "Stream": "yh668", "UpdateTime": , "Width": "1092" "RetCode": 0, "RetMsg": "success", "Total": 1, "UniqueName": "xxx" Postma n 调用示例 GET 方法的调用均使用相同的方法示例中参数错误, 故返回失败结果查询流历史信息接口 (List Hist orypu b S t reamsin fo) 接口说明金山云 7/15

8 此接口用于查询 UniqueName-App-Pubdomain, 或单路流 Stream 下已结束流的历史信息 ; 时间范围 :28 天之内的历史数据 ; 查询数据间隔 : 开始结束时间间隔不能超过 5 天 ; 请求参数是否必须 Action String Y 操作接口名, 取值 :ListHistoryPubStreamsInfo Version String Y 版本号, 取值 : UniqueName string Y 域名标识 App string Y 应用名 Pubdomain string Y 推流域名 Stream string N 流名 OrderTime int N 排序 (0: 从最新的开始,1: 从后向前 ), 默认为 0 Marker int N 起始游标, 默认为 0 Limit int N 单次请求返回配置数量限制, 默认 1000 StartUnixTi me int N 查询开始 UTC 时间 ; 默认 5 天前的 0 点 ; 开始和结束时间间隔不能超过 5 天, 只能查 28 天之内的数据 EndUnixTime int N 查询结束 UTC 时间 ; 默认当前时间 ; 开始和结束时间间隔不能超过 5 天, 只能查 28 天之内的数据返回参数 UniqueName string 域名标识 App string 应用名 Pubdomain string 推流域名 Stream string 流名 StartUnixTime int 查询开始 UTC 时间 EndUnixTime int 查询结束 UTC 时间 Count int 返回记录数 OrderTime int 排序,0: 从最新的录制任务开始,1: 从后向前 Total int 记录总数 ClientIP String 推流客户端 IP PubTime int 开始推流的时间,UTC 格式 FinTime int 推流结束时间,UTC 格式金山云 8/15

9 StatusCode int 断流原因错误码 StatusMessage string 断流原因英文 RetCode int 响应码 0 成功其他失败 RetMsg string 错误信息请求示例 main=xxx.xxx.com&marker=0&limit=2&ordertime=0 返回示例 "Data": "App": "live", "Count": 2, "EndUnixtime": , "Marker": 0, "OrderTime": 0, "Pubdomain": "xxx.xxx.com", "Result": [ "Detail": [ "Clientip": " ", "Fintime": , "Pubtime": , "StatusCode": 200, "StatusMessage": "success" "Stream": "stream5", "Detail": [ "Clientip": " ", "Fintime": , "Pubtime": , "StatusCode": 200, "StatusMessage": "success" "Stream": "stream2" "RetCode": 0, "RetMsg": "success", "StartUnixtime": , "Total": , "UniqueName": "xxx" 金山云 9/15

10 查询流历史错误信息接口 (List Hist orypu b S t reamse rrin fo) 接口此接口用于查询 Pubdomain 下或者单路流 Stream 历史错误信息时间范围 :28 天之内的历史数据查询数据间隔 : 开始结束时间间隔不能超过 5 天请求参数是否必须 Action String Y 操作接口名, 取值 :ListHistoryPubStreamsErrInfo Version String Y 版本号, 取值 : UniqueName string Y 域名标识 App string Y 应用名 Pubdomain string Y 推流域名 Stream string N 流名 OrderTime int N 排序 (0: 从最新的开始,1: 从后向前 ), 默认为 0 Marker int N 起始游标, 默认为 0 Limit int N 单次请求返回配置数量限制, 默认 1000 StartUnixTi me int N 查询开始 UTC 时间 ; 默认 5 天前的 0 点 ; 开始和结束时间间隔不能超过 5 天, 只能查 28 天之内的数据 EndUnixTime int N 查询结束 UTC 时间 ; 默认当前时间 ; 开始和结束时间间隔不能超过 5 天, 只能查 28 天之内的数据返回参数 UniqueName string 域名标识 App string 应用名 Pubdomain string 推流域名 Stream string 流名 StartUnixTime int 查询开始 UTC 时间 EndUnixTime int 查询结束 UTC 时间 Count int 返回记录数金山云 10/15

11 OrderTime int 排序,0: 从最新的录制任务开始,1: 从后向前 Total int 记录总数 ClientIP String 推流客户端 IP PubTime int 开始推流的时间,UTC 时间 FinTime int 推流结束时间,UTC 时间 StatusCode int 断流原因错误码 StatusMessage string 断流原因英文 RetCode int 响应码 0 成功其他失败 RetMsg string 错误信息请求示例 main=xxx.xxx.com&marker=0&limit=2&ordertime=0 返回示例金山云 11/15

12 "Data": "App": "live", "Count": 2, "EndUnixtime": , "Marker": 0, "OrderTime": 0, "Pubdomain": "xxx.xxx.com", "Result": [ "Detail": [ "Clientip": "localhost", "Fintime": , "Pubtime": , "StatusCode": 422, "StatusMessage": "Unknown", "Clientip": "localhost", "Fintime": , "Pubtime": , "StatusCode": 422, "StatusMessage": "Unknown" "Stream": "stream" "RetCode": 0, "RetMsg": "success", "StartUnixtime": , "Total": 5275, "UniqueName": "xxx" 查询主播流时长接口 (List S t reamdu rat ion s ) 统计每天主播推流时长 ; 历史记录 :2 个月内 ; 统计方式 : 在 24 点进行时长统计, 如输入的开始时间在前天, 结束时间在今天, 就返回昨天这条流的推流时长 ( 即同一条流推流时间若跨越 24 点需切割统计 ); 如果昨天之内流有断流的情况, 则返回多条记录 ; 此接口需开通才能应用, 请联系技术支持请求参数金山云 12/15

13 是否必须 Action Sring Y 操作接口名, 取值 :ListStreamDurations Version String Y 版本号, 取值 : UniqueName String Y 域名标识 App String Y 频道 Pubdomain String Y 推流域名 Stream String N 流名, 若携带则返回此路流的推流时长, 不携带返回整个 Pubdomain 下所有流的推流时长 StartUnixTi me unsignedi nt Y 查询开始时间,UTC 时间戳, 不携带时默认前一天 00:00 点 EndUnixTime unsignedi nt Y 查询结束时间,UTC 时间戳, 不携带时默认当前时间返回参数 UniqueName Sring 域名标识 App Sring 频道 Pubdomain Sring 推流域名 Stream Sring 流名 StartTime unsignedint 推流开始时间 EndTime unsignedint 推流结束时间 Duration unsignedint 每段推流的总时长 Count int 单次返回记录数请求示例 &Acti on=liststreamdurations&version= & 公共参数返回示例请求参数不携带 Strea m 时, 返回 Pubdo m a in 下所有流的推流时长 ; 注意 : 同一条流若在一天内存在断流情况, 则返回多条记录, 如下 11; 金山云 13/15

14 "Data": "App":"live", "Count":5, "Pubdomain":"xxx.xxxxx.com", "Result":[ "Duration":11, "EndTime": , "StartTime": , "Stream":" ", "Duration":11, "EndTime": , "StartTime": , "Stream":" ", "Duration":22, "EndTime": , "StartTime": , "Stream":" ", "Duration":33, "EndTime": , "StartTime": , "Stream":" ", "Duration":555, "EndTime": , "StartTime": , "Stream":" " "RetCode":0, "RetMsg":"success", "UniqueName":"xxx", "RequestId":"2125d244-7f40-45f0-91e8-05e046b3a61c" 请求参数携带 Strea m 时, 只返回此路流的推流时长 ; 如下金山云 14/15

15 "Data": "App":"live", "Count":2, "Pubdomain":"xxx.xxxxx.com", "Result":[ "Duration":11, "EndTime": , "StartTime": , "Stream":" ", "Duration":11, "EndTime": , "StartTime": , "Stream":" " "RetCode":0, "RetMsg":"success", "UniqueName":"xxx", "RequestId":"2125d244-7f40-45f0-91e8-05e046b3a61c" 金山云 15/15

预热缓存接口

预热缓存接口 1 3 3 4 4 4 4 4 6 6 6 6 6 7 7 10 10 10 10 11 目录目录目录 PreloadCaches 描述请求语法请求参数返回参数示例 RefreshCaches 描述请求语法请求参数返回参数示例 GetRefreshOrPreloadTask 描述请求参数返回参数 Data 示例 GetRefreshOrPreloadQuota 描述请求语法返回参数示例目录 018-04-1