DescribeLiveStreamsPublishList - 查询域名历史流列表

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

接口说明

调用本接口最多可查询近 30 天的历史流。返回的数据为查询时间段内的在线流信息。本接口目前支持以下排序方式:

  • stream_name_desc:按直播流名称倒序。

  • stream_name_asc:按直播流名称升序。

  • publish_time_desc:按推流时间倒序。

  • publish_time_asc:按推流时间升序。

QPS 限制

本接口的单用户 QPS 限制为 3 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:DescribeLiveStreamsPublishListget
*全部资源
*

请求参数

名称类型必填描述示例值
DomainNamestring

推流域名或主播流域名。

example.com
AppNamestring

播流所属应用名称。您可在流管理页面查看 AppName。

liveApp****
StreamNamestring

播流名称。您可在流管理页面查看 StreamName。

liveStream****
StartTimestring

推流时间。

格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2017-12-21T08:00:00Z
EndTimestring

结束时间。EndTime 和 StartTime 之间的间隔不能超过 30 天。

格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2017-12-22T08:00:00Z
PageSizeinteger

分页大小。取值范围:1~3000,默认值为 2000

1500
PageNumberinteger

当前页码。默认值为 1

1
StreamTypestring

流类型。取值:

  • 不传:查询原始流。
  • all:查询所有流。
  • trans:查询转码流。
all
QueryTypestring

指定是否模糊匹配流名称。取值:

  • fuzzy(默认值):模糊匹配。
  • strict:精准匹配。
fuzzy
OrderBystring

排序方式。取值:

  • stream_name_desc:按直播流名称倒序。
  • stream_name_asc:按直播流名称升序。
  • publish_time_desc:按推流时间倒序。
  • publish_time_asc(默认值):按推流时间升序。
publish_time_desc

返回参数

名称类型描述示例值
object
TotalPageinteger

总页数。

2
PageNuminteger

分页的页码。

2
PageSizeinteger

每页大小。

10
RequestIdstring

请求 ID。

40A4F36D-A7CC-473A-88E7-154F92242566
TotalNuminteger

符合条件的总个数。

11
PublishInfoarray<object>

推流记录信息。

LiveStreamPublishInfoobject
EdgeNodeAddrstring

CDN 上行节点 IP。

10.175.XX.XX
PublishUrlstring

推流完整 URL 地址。

rtmp://demo.aliyundoc.com/liveApp****/liveStream****
StreamNamestring

播流名称。

liveStream****
DomainNamestring

推流域名或主播流域名。

example.com
StopTimestring

停止推流时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2015-12-02T03:11:19Z
TranscodeIdstring

转码模板 ID。

说明 当 Transcoded 参数为 no 时,不返回此参数。
ld
PublishDomainstring

推流域名。

demo.aliyundoc.com
AppNamestring

播流所属应用名称。

liveApp****
PublishTimestring

开始推流时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2015-12-02T03:05:53Z
PublishTypestring

推流类型。取值:

  • edge:边缘推流。
  • center:中心推流。
edge
Transcodedstring

是否是转码流。

yes
ClientAddrstring

主播 IP。

10.175.XX.XX
StreamUrlstring

播流的 URL。

http://example.com/liveApp****/liveStream****.flv

示例

正常返回示例

JSON格式

{
  "TotalPage": 2,
  "PageNum": 2,
  "PageSize": 10,
  "RequestId": " 40A4F36D-A7CC-473A-88E7-154F92242566",
  "TotalNum": 11,
  "PublishInfo": {
    "LiveStreamPublishInfo": [
      {
        "EdgeNodeAddr": "10.175.XX.XX",
        "PublishUrl": "rtmp://demo.aliyundoc.com/liveApp****/liveStream****",
        "StreamName": "liveStream****",
        "DomainName": "example.com",
        "StopTime": "2015-12-02T03:11:19Z",
        "TranscodeId": "ld",
        "PublishDomain": "demo.aliyundoc.com",
        "AppName": "liveApp****",
        "PublishTime": "2015-12-02T03:05:53Z",
        "PublishType": "edge",
        "Transcoded": "yes",
        "ClientAddr": "10.175.XX.XX",
        "StreamUrl": "http://example.com/liveApp****/liveStream****.flv"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400QpsOverLimitQps is over limit for this domainName.-
400InvalidStartTime.MalformedSpecified parameter StartTime is not valid.StartTime参数错误,请您确认该StartTime参数是否正确。
400InvalidEndTime.MalformedSpecified parameter EndTime is not valid.结束时间错误,请您确认结束时间是否正确。
400InvalidStartTime.ValueNotSupportedThe specified value of parameter StartTime is not supported.传入的StartTime参数不支持。
400InvalidEndTime.MismatchSpecified end time does not match the specified start time.-
400Duration.ExceedDuration between StartTime and EndTime is too long.-

访问错误中心查看更多错误码。