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

使用说明

调用本接口仅支持查询一年内的截图数据。

QPS限制

本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeLiveStreamSnapshotInfo	系统规定参数。取值：DescribeLiveStreamSnapshotInfo。
DomainName	String	是	example.com	主播流域名。
AppName	String	是	liveApp****	播流所属应用名称。
StreamName	String	是	liveStream****	播流名称。
StartTime	String	是	2017-12-21T08:00:00Z	开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
EndTime	String	是	2017-12-22T08:00:00Z	结束时间。EndTime和StartTime之间的间隔不能超过1天。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
Limit	Integer	否	10	一次调用获取的数量。取值范围：1~100，默认值：10。
Order	String	否	asc	排序。取值： asc（默认值）：升序。 desc：降序。

返回数据


名称	类型	示例值	描述
NextStartTime	String	2015-12-01T17:36:00Z	下一个起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。说明当此时间范围内的内容超出了Limit的取值范围，则返回此参数，为下一个文件的创建时间。可以将此时间当做StartTime，重新调用此接口获取下一段内容，不传则表示未超出Limit取值范围。
RequestId	String	62136AE6-7793-45ED-B14A-60D19A9486D3	请求ID。
LiveStreamSnapshotInfoList	Array of LiveStreamSnapshotInfo		截图内容列表。
LiveStreamSnapshotInfo
OssObject	String	{liveApp**}/{liveStream**}.jpg	OSS存储的文件名。
OssBucket	String	liveBucket****	OSS存储Bucket名称。
CreateTime	String	2015-12-01T17:36:00Z	截图产生时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
OssEndpoint	String	cn-oss-****.aliyuncs.com	OSS存储的Endpoint名称。
IsOverlay	Boolean	false	截图方式。取值： true：覆盖截图。 false：序列截图。
CreateTimestamp	Long	1653641526637	截图文件创建的毫秒级时间戳。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=DescribeLiveStreamSnapshotInfo
&DomainName=example.com
&AppName=liveApp****
&StreamName=liveStream****
&StartTime=2017-12-21T08:00:00Z
&EndTime=2017-12-22T08:00:00Z
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeLiveStreamSnapshotInfoResponse>
    <NextStartTime>2015-12-01T17:36:00Z</NextStartTime>
    <RequestId>62136AE6-7793-45ED-B14A-60D19A9486D3</RequestId>
    <LiveStreamSnapshotInfoList>
        <OssObject>{liveApp****}/{liveStream****}.jpg</OssObject>
        <OssBucket>liveBucket****</OssBucket>
        <CreateTime>2015-12-01T17:36:00Z</CreateTime>
        <OssEndpoint>cn-oss-****.aliyuncs.com</OssEndpoint>
        <IsOverlay>false</IsOverlay>
        <CreateTimestamp>1653641526637</CreateTimestamp>
    </LiveStreamSnapshotInfoList>
</DescribeLiveStreamSnapshotInfoResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "NextStartTime" : "2015-12-01T17:36:00Z",
  "RequestId" : "62136AE6-7793-45ED-B14A-60D19A9486D3",
  "LiveStreamSnapshotInfoList" : [ {
    "OssObject" : "{liveApp****}/{liveStream****}.jpg",
    "OssBucket" : "liveBucket****",
    "CreateTime" : "2015-12-01T17:36:00Z",
    "OssEndpoint" : "cn-oss-****.aliyuncs.com",
    "IsOverlay" : false,
    "CreateTimestamp" : 1653641526637
  } ]
}

错误码


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.	直播流不存在，请您确认直播流是否正确。

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