Queries the snapshots that are captured within a specified period.

Usage note

You can query only snapshots that are captured within one year.

QPS limit

You can call this operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see QPS limit on an API operation in ApsaraVideo Live.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeLiveStreamSnapshotInfo

The operation that you want to perform. Set the value to DescribeLiveStreamSnapshotInfo.

DomainName String Yes example.com

The name of the main streaming domain.

AppName String Yes liveApp****

The name of the application to which the live stream belongs.

StreamName String Yes liveStream****

The name of the live stream.

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

The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

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

The end of the time range to query. The duration specified by the StartTime parameter and the EndTime parameter cannot exceed one day. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

Limit Integer No 10

The number of snapshots to be returned upon one call. Valid values: 1 to 100. Default value: 10.

Order String No asc

The order in which the query results are displayed. Valid values:

  • asc: The query results are displayed in the ascending order. This is the default value.
  • desc: The query results are displayed in the descending order.

Response parameters

Parameter Type Example Description
NextStartTime String 2015-12-01T17:36:00Z

The time when the operation was called for the next time. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

Note If the number of snapshots that are captured within the specified period exceeds the value of the Limit parameter, this parameter is returned. The parameter value indicates the time to call the DescribeLiveStreamSnapshotInfo operation again. If this parameter is not returned, the number of snapshots that are captured within the specified period does not exceed the specified limit.
RequestId String 62136AE6-7793-45ED-B14A-60D19A9486D3

The ID of the request.

LiveStreamSnapshotInfoList Array of LiveStreamSnapshotInfo

The snapshots.

LiveStreamSnapshotInfo
OssObject String {liveApp****}/{liveStream****}.jpg

The name of the snapshot that is stored in an Object Storage Service (OSS) bucket.

OssBucket String liveBucket****

The name of the OSS bucket in which the snapshot is stored.

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

The time when the snapshot was captured. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

OssEndpoint String cn-oss-****.aliyuncs.com

The endpoint of OSS.

IsOverlay Boolean false

The saving mode of the snapshot. Valid values:

  • true: The snapshot is overwritten.
  • false: The snapshot is not overwritten. All snapshots are stored in order by time.
CreateTimestamp Long 1653641526637

The timestamp when the snapshot file was created. Unit: milliseconds.

Examples

Sample requests

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
&<Common request parameters>

Sample responses

XML format 

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 format 

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
  } ]
}

Error codes

HTTP status code Error code Error message Description
400 InvalidStartTime.Malformed Specified parameter StartTime is not valid. The error message returned because the format of the start time is invalid. Check whether the value of the StartTime parameter is valid.
400 InvalidEndTime.Malformed Specified parameter EndTime is not valid. The error message returned because the format of the end time is invalid. Check whether the value of the EndTime parameter is valid.
400 InvalidEndTime.Mismatch Specified end time does not math the specified start time. The error message returned because the end time is not later than the start time or the time range specified by the StartTime and EndTime parameters is beyond one day. Check whether the values of the StartTime and EndTime parameters are valid.
400 InvalidStream.NotFound Speicified stream does not exist. The error message returned because the live stream does not exist. Check whether the value of the StreamName parameter is valid.

For a list of error codes, visit the API Error Center.