全部产品

DescribeVsStreamsPublishList

描述

获取某一时间段内某个域名(或域名下某应用或某个流)的推流记录

请求参数

参数 类型 是否必须 描述
Action String 操作接口名,系统规定参数,取值:DescribeVsStreamsPublishList
DomainName String 您的域名
AppName String 直播流所属应用名称
StreamName String 直播流名称
QueryType String 指定是否模糊匹配流名称,取值:fuzzy、strict,对应模糊匹配、精准匹配
StartTime String 起始时间,UTC格式,例如:2016-06-29T19:00:00Z
EndTime String 结束时间,UTC格式,例如:2016-06-30T19:00:00Z,EndTime和StartTime之间的间隔不能超过30天
PageSize Integer 每页大小,默认3000,最大3000,取值:1~3000之前的任意整数
PageNumber Integer 取得第几页,默认1

返回参数

名称 类型 描述
PublishInfo LiveStreamPublishInfo[] 推流记录信息
PageNum Integer 分页的页码
PageSize Integer 每页大小
TotalPage Integer 总页数
TotalNum Integer 符合条件的总个数

数据类型

LiveStreamPublishInfo

名称 类型 描述
DomainName String 流所属加速域名
AppName String 流所属应用名称
StreamName String 直播流名称
StreamUrl String 直播流的URL
PublishTime String 开始推流时刻 UTC时间
StopTime String 停止推流时刻 UTC时间
ClientAddr String 主播IP
EdgeNodeAddr String CDN上行节点IP
PublishUrl String 推流完整URL地址
PublishDomain String 推流域名
PublishType String 推流类型,边缘推流:edge,中心推流:center
Transcoded String 是否是转码流,yes:是,no:没有
TranscodeId String 若转码过,返回转码模板id

特殊错误码

错误代码 描述 Http 状态码 语义
InternalError The request processing has failed due to some unknown error. 500 后台发生未知错误
InvalidDomain.NotFound The domain provided does not exist in our records. 404 当前账户下未查到域名
IllegalOperation Illegal domain operate is not permitted. 403 不支持当前操作,如:非直播类域名
InvalidStartTime.Malformed Specified parameter StartTime is not valid. 400 开始时间错误
InvalidEndTime.Malformed Specified parameter EndTime is not valid. 400 结束时间错误
InvalidEndTime.Mismatch Specified end time does not math the specified start time. 400 结束时间与开始时间不匹配

示例

请求示例:

  1. https://vs.aliyuncs.com?Action=DescribeVsStreamsPublishList&DomainName=example.com&StartTime=2015-06-25T03:30:50Z&EndTime=2015-12-26T03:30:50Z&PageSize=10&PageNum=2&<公共请求参数>

返回示例

JSON格式:

  1. {
  2. "RequestId": "1C0E0C22-77B7-42AC-8212-AF99B2E0077F",
  3. "PageNum": 2,
  4. "PageSize": 10,
  5. "TotalNum": 11,
  6. "TotalPage": 2,
  7. "PublishInfo": {
  8. "LiveStreamPublishInfo": [
  9. {
  10. "DomainName": "example.com",
  11. "AppName": "xchen",
  12. "StreamName": "testxchen",
  13. "StreamUrl": "rtmp://xxx/xxxx",
  14. "PublishTime": "2015-12-02T03:05:53Z",
  15. "StopTime": "2015-12-02T03:11:19Z",
  16. "ClientAddr": "10.175.60.33",
  17. "EdgeNodeAddr": "10.175.30.21",
  18. "PublishUrl": "rtmp://example.com/xchen",
  19. "PublishDomain": "example.com",
  20. "PublishType": "center", //边缘推流edge,中心推流center
  21. "Transcoded": "yes",
  22. "TranscodeId": "small"
  23. }
  24. ]
  25. }
  26. }