查询流历史信息接口

最近更新时间:2020-05-27 20:56:44

查询流历史信息接口(ListHistoryPubStreamsInfo)

接口说明

此接口用于查询UniqueName-App-Pubdomain,或单路流Stream下已结束流的历史信息;

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

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

请求参数

参数名 类型 是否必须 描述
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
Limit int N 单次请求返回配置数量限制,默认1000
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 排序类型,0:从最新的录制任务开始,1:从后向前
Total int 记录总数
ClientIP String 推流客户端IP
PubTime int 开始推流的时间,UTC格式
FinTime int 推流结束时间,UTC格式
StatusCode int 断流原因错误码
StatusMessage string 断流原因英文描述
RetCode int 响应码 0成功 其他失败
RetMsg string 错误信息

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

错误码 英文描述
200 Sucess 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": "success"
          }
        ],
        "Stream": "stream5"
      },
      {
        "Detail": [
          {
            "Clientip": "11.11.11.11",
            "Fintime": 1492070332,
            "Pubtime": 1492070321,
            "StatusCode": 200,
            "StatusMessage": "success"
          }
        ],
        "Stream": "stream2"
      }
    ],
    "RetCode": 0,
    "RetMsg": "success",
    "StartUnixtime": 1491580800,
    "Total": 164745,
    "UniqueName": "xxx"
  }
}

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

免费注册