调用DescribeLiveStreamSnapshotInfo查询某一段时间内截图内容。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeLiveStreamSnapshotInfo

系统规定参数。取值:DescribeLiveStreamSnapshotInfo

AppName String testApp

播流所属应用名称。

DomainName String live.yourdomain.com

播流域名。

EndTime String 2017-12-22T08:00:00Z

结束时间。EndTime和StartTime之间的间隔不能超过1天。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

StartTime String 2017-12-21T08:00:00Z

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

StreamName String testStream

播流名称。

Limit Integer 10

一次调用获取的数量。取值范围:1~100, 默认值:10

Order String asc

排序。取值:

  • asc(默认值):升序。
  • desc:降序。

返回数据

名称 类型 示例值 描述
RequestId String 62136AE6-7793-45ED-B14A-60D19A9486D3

请求ID。

LiveStreamSnapshotInfoList Array of LiveStreamSnapshotInfo

截图内容列表。

LiveStreamSnapshotInfo
CreateTime String 2015-12-01T17:36:00Z

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

OssBucket String livevideo-test

OSS存储Bucket名称。

OssEndpoint String oss-cn-shanghai.aliyuncs.com

OSS存储的Endpoint名称。

OssObject String {AppName}/{StreamName}.jpg

OSS存储的文件名。

NextStartTime String 2015-12-01T17:36:00Z

下一个起始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

说明 当此时间范围内的内容超出了Limit的取值范围,则返回此参数,为下一个文件的创建时间。可以将此时间当做StartTime,重新调用此接口获取下一段内容,不传则表示未超出Limit取值范围。

示例

请求示例

https://live.aliyuncs.com/?Action=DescribeLiveStreamSnapshotInfo
&AppName=testApp
&DomainName=live.yourdomain.com
&EndTime=2017-12-22T08:00:00Z
&StartTime=2017-12-21T08:00:00Z
&StreamName=testStream
&<公共请求参数>

正常返回示例

XML 格式

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

JSON 格式

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

错误码

HttpCode 错误码 错误信息 描述
400 InvalidStartTime.Malformed Specified parameter StartTime is not valid. StartTime参数错误,请您确认该StartTime参数是否正确。
400 InvalidEndTime.Malformed Specified parameter EndTime is not valid. 结束时间错误,请您确认结束时间是否正确。
400 InvalidEndTime.Mismatch Specified end time does not math the specified start time. 结束时间与开始时间不匹配,请您确认时间的匹配度。
400 InvalidStream.NotFound Speicified stream does not exist. 直播流不存在,请您确认直播流是否正确。

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