全部文档
当前文档

暂无内容

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

文档中心

查询历史推流信息

最近更新时间:2024-03-27 15:34:26

查询历史推流信息(GetHistoryPubStreamsInfo)

接口描述

  • 此接口用来查询域名下某发布点或某条流的历史推流信息

  • 数据粒度:60s,300s

  • 数据延时:30min

  • 限制访问频率:50次/分钟

  • 时间范围:28天之内的历史数据

  • 查询数据间隔:开始结束时间间隔不能超过1天

  • 调用方式:HTTP GET

  • 签名机制

    • Service取值:kls

  • 接入地址:kls.api.ksyun.com︎

请求参数

参数名

类型

是否必须

描述

UniqueName

string

Y

域名标识

App

string

Y

应用名

Pubomain

string

Y

推流域名

Stream

string

Y

流名,支持多选,单次最多支持查询20条流
(注:流名不能带逗号,否则请求会异常)

OrderTime

Int

N

排序类型(0:按FinTime降序排列,1:按FinTime升序排列),默认为0
降序:即一个json从上往下,从大到小排列

Marker

Int

N

起始游标,默认为0

Limit

Int

N

单次请求返回配置数量限制,默认1000

StartUnixTime

int

N

查询开始UTC时间;默认当前时间前35分钟;开始和结束时间间隔不能超过1天

EndUnixTime

int

N

查询结束UTC时间;默认当前时间30分钟,不得晚于当前时间30分钟前;开始和结束时间间隔不能超过1天

Interval

int

Y

数据时间粒度,单位秒,支持60s和300s两个粒度
1分钟粒度的时间查询跨度建议不要超过5小时

返回参数

参数名

类型

描述

RetCode

int

响应码,0:成功,其他失败

RetMsg

string

错误信息

Count

int

返回记录数

OrderTime

int

排序类型,0:按推流开始时间降序排列,1:按推流开始时间升序排列

Marker

int

起始游标,默认为0

Total

int

记录总数

UniqueName

string

域名标识

Pubdomain

string

推流域名

App

string

应用名

StartUnixTime

int

查询开始UTC时间

EndUnixTime

int

查询结束UTC时间

Result

Array

查询返回结果,具体内容见【Result详细说明】

Result详细说明

参数名

类型

描述

Stream

string

流名

Detail

Array

流详细信息,具体见【Detail详细说明】

Detail详细说明

参数名

类型

描述

Time

String

数据返回时间

ClientIP

String

推流客户端IP

ServerIP

String

推流边缘节点IP

PubTime

Int64

开始推流的时间,UTC格式

FinTime

Int64

推流结束时间,UTC格式

StatusCode

int

断流原因错误码

StatusMessage

string

断流原因英文描述

BwInVideoExpkb

int

理论视频码率,单位kbps

BwInVideo

int

真实视频码率,单位kbps

FrameRate

int

理论视频帧率

Curfps

int

真实视频帧率

BwInAudioExpkb

int

理论音频码率,单位kbps

BwInAudio

int

真实音频码率,单位kbps

CurAudioFps

int

真实音频帧率

请求示例

GET /?Action=GetHistoryPubStreamsInfo&Version=2017-01-01&UniqueName=abc&App=live&Pubdomain=xxx&Marker=0&Limit=2&OrderTime=0&Stream=stream-123&StartUnixTime=1607240944&EndUnixTime=1607248144&Interval=60
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

返回示例

{
    "Data": {
        "RetCode": 0,
        "RetMsg": "success",
        "UniqueName": "xxx",
        "StartUnixTime": 1607240944,
        "EndUnixTime": 1607248144,
        "Count": 2,
        "OrderTime": 0,
        "App": "live",
        "Marker": 0,
        "Pubdomain": "xxx",
        "Total": 122,
        "Result": [
            {
                "Detail": [
                    {
                        "Time": "2020-12-06 17:48:00",
                        "Clientip": "124.238.72.16:12896",
                        "Serverip": "27.128.211.87",
                        "Fintime": 1607248139722,
                        "Pubtime": 1607246836041,
                        "BwInVideoExpkb": 1609,
                        "BwInVideo": 1600,
                        "Curfps": 14,
                        "FrameRate": 14,
                        "BwInAudio": 102,
                        "BwInAudioExpkb": 102,
                        "CurAudioFps": 42,
                        "StatusCode": 0,
                        "StatusMessage": "rtmp_client_close_session"
                    },
                    {
                        "Time": "2020-12-06 17:47:00",
                        "Clientip": "124.238.72.16:12896",
                        "Serverip": "27.128.211.87",
                        "Fintime": 1607248029720,
                        "Pubtime": 1607246836041,
                        "BwInVideoExpkb": 1609,
                        "BwInVideo": 1600,
                        "Curfps": 14,
                        "FrameRate": 14,
                        "BwInAudio": 102,
                        "BwInAudioExpkb": 102,
                        "CurAudioFps": 42,
                        "StatusCode": 0,
                        "StatusMessage": "rtmp_client_close_session"
                    }
                ],
                "Stream": "stream-123"
            }
        ]
    },
    "RequestId": "c02ee6e7-531e-48da-830f-f1995f387b23"
}

错误码

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

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

纯净模式

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