全部文档
当前文档

暂无内容

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

文档中心

查询流历史信息

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

查询流历史信息(ListHistoryPubStreamsInfo)

接口描述

  • 此接口用来查询某App下所有或单条流的历史信息

  • 时间范围:28天

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

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

  • 调用方式:HTTP GET

  • 签名机制

    • Service取值:kls

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

请求参数

参数名

类型

是否必须

描述

Action

String

Y

操作接口名,取值:ListHistoryPubStreamsInfo

Version

String

Y

版本号,取值:2017-01-01

UniqueName

String

Y

域名空间

App

String

Y

应用名

Pubdomain

String

Y

推流域名

Stream

String

N

流名

OrderTime

Int

N

排序类型(0:按推流开始的时间降序排列,1:按推流开始的时间升序排列),默认为0

Marker

Int

N

起始游标,默认为0。0代表第1页的数据,以此类推

Limit

Int

N

每页返回的记录数,默认1000。单页最多返回5000条数据

StartUnixTime

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

排序类型

Total

Int

符合查询条件的记录总数

ClientIP

String

推流客户端IP

PubTime

Int

推流开始时间,UTC时间戳

FinTime

Int

推流结束时间,UTC时间戳

StatusCode

Int

断流原因错误码

StatusMessage

String

断流原因描述

RetCode

Int

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

RetMsg

String

响应信息描述

断流原因错误码及英文描述

错误码

英文描述

200

Success operation!

422

Already exist stream!

423

Forbidden by blacklist!

425

Url expired!

426

Signature does not match!

428

Bad params!

请求示例

GET /?Action=ListHistoryPubStreamsInfo&Version=2017-01-01&UniqueName=xxx&App=live&Pubdomain=xxx.xxx.com&Marker=0&Limit=2&OrderTime=0 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

返回示例

{
  "Data": {
    "App": "live",
    "Count": 2,
    "EndUnixtime": 1492070336,
    "Marker": 0,
    "OrderTime": 0,
    "Pubdomain": "xxx.xxx.com",
    "Result": [
      {
        "Detail": [
          {
            "Clientip": "11.11.11.11",
            "Fintime": 1492070325,
            "Pubtime": 1492070324,
            "StatusCode": 200,
            "StatusMessage": "Sucess operation!"
          }
        ],
        "Stream": "stream5"
      },
      {
        "Detail": [
          {
            "Clientip": "11.11.11.11",
            "Fintime": 1492070332,
            "Pubtime": 1492070321,
            "StatusCode": 200,
            "StatusMessage": "Sucess operation!"
          }
        ],
        "Stream": "stream2"
      }
    ],
    "RetCode": 0,
    "RetMsg": "success",
    "StartUnixtime": 1491580800,
    "Total": 164745,
    "UniqueName": "xxx"
  }
}

错误码

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

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

纯净模式

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