获取某一时间段内某个域名(或域名下某应用或某个流)的历史推流记录。
接口说明
使用说明
调用本接口最多可查询近 30 天的历史流。返回的数据为查询时间段内的在线流信息。本接口目前支持以下排序方式:
-
stream_name_desc:按直播流名称倒序。
-
stream_name_asc:按直播流名称升序。
-
publish_time_desc:按推流时间倒序。
-
publish_time_asc:按推流时间升序。
QPS 限制
本接口的单用户 QPS 限制为 3 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
live:DescribeLiveStreamsPublishList | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DomainName | string | 是 | 推流域名或主播流域名。 | example.com |
AppName | string | 否 | 播流所属应用名称。 | liveApp**** |
StreamName | string | 否 | 播流名称。 | liveStream**** |
StartTime | string | 是 | 推流时间。 格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 | 2017-12-21T08:00:00Z |
EndTime | string | 是 | 结束时间。EndTime 和 StartTime 之间的间隔不能超过 30 天。 格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 | 2017-12-22T08:00:00Z |
PageSize | integer | 否 | 分页大小。取值范围:1~3000,默认值为 2000。 | 1500 |
PageNumber | integer | 否 | 当前页码。默认值为 1。 | 1 |
StreamType | string | 否 | 流类型。取值:
| all |
QueryType | string | 否 | 指定是否模糊匹配流名称。取值:
| fuzzy |
OrderBy | string | 否 | 排序方式。取值:
| publish_time_desc |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | QpsOverLimit | Qps is over limit for this domainName. | - |
400 | InvalidStartTime.Malformed | Specified parameter StartTime is not valid. | StartTime参数错误,请您确认该StartTime参数是否正确。 |
400 | InvalidEndTime.Malformed | Specified parameter EndTime is not valid. | 结束时间错误,请您确认结束时间是否正确。 |
400 | InvalidStartTime.ValueNotSupported | The specified value of parameter StartTime is not supported. | 传入的StartTime参数不支持。 |
400 | InvalidEndTime.Mismatch | Specified end time does not match the specified start time. | - |
400 | Duration.Exceed | Duration between StartTime and EndTime is too long. | - |
访问错误中心查看更多错误码。