查询截图信息_直播截图_API 参考

描述

查询一段时间内截图内容。

请求参数

参数	类型	是否必须	描述
Action	String	是	操作接口名，系统规定参数，取值：DescribeLiveStreamSnapshotInfo
DomaiName	String	是	您的加速域名
AppName	String	是	直播流所属应用名称
StreamName	String	是	直播流名称
StartTime	String	是	开始时间，格式：2015-12-01T17:36:00Z
EndTime	String	是	结束时间，格式：2015-12-01T17:36:00Z，EndTime 和 StartTime 之间的间隔不能超过 1 天
Limit	Integer	否	一次调用获取的数量，范围 1~100，默认值：10

返回参数

名称	类型	描述
RequestId	String	该条任务请求 ID。
LiveStreamSnapshotInfoList	LiveStreamSnapshotInfo[]	截图内容列表，没有则返回空数组。
NextStartTime	String	下一个起始时间，当此时间范围内的内容超出了 limit 的数量限制，则返回此参数，表示下一个文件的创建时间，可以将此时间当做 StartTime，重新调用此接口获取下一段内容，不传则表示未超出 limit 数量。

数据类型

LiveStreamSnapshotInfo

名称	类型	描述
OSSEndpoint	String	OSS endpoit
OSSBucket	String	OSS 存储 bucket 名称
OSSObject	String	OSS 存储的录制文件名
CreateTime	String	截图产生时间，格式：2015-12-01T17:36:00Z

特殊错误码

错误代码	描述	Http 状态码	语义
InvalidLimit	Specified parameter Limit is invalid.	400	Limit参数不合法
InvalidStartTime.Malformed	Specified parameter StartTime is invalid.	400	开始时间错误
InvalidEndTime.Malformed	Specified parameter EndTime is invalid.	400	结束时间错误
InvalidEndTime.Mismatch	Specified end time does not math the specified start time.	400	结束时间与开始时间不匹配
InvalidStream.NotFound	The speicified stream does not exist.	400	直播流不存在

示例

请求示例：

https://live.aliyuncs.com?Action=DescribeLiveStreamSnapshotInfo&DomainName=xxxxx&AppName=aliyuntest&StreamName=xxx&StartTime=xxx&EndTime=xxx&<公共请求参数>

关于公共请求参数详细内容，请参考公共请求参数。

返回示例

JSON格式：

{
  "RequestId": "62136AE6-7793-45ED-B14A-60D19A9486D3",
  "LiveStreamSnapshotInfoList": {
    "LiveStreamSnapshotInfo": [
      {
        "CreateTime": "2016-05-25T09:41:09Z",
        "OssEndpoint": "oss-test.aliyun-inc.com",
        "OssObject": "{AppName}/{StreamName}.jpg",
        "OssBucket": "livevideo-test"
      }
    ]
  },
  "NextStartTime":"2015-12-01T17:36:00Z"
}