Queries the snapshots that are captured within a specified period.

You can query data of the last year.

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.

AppName String Yes testApp

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

DomainName String Yes live.yourdomain.com

The streaming domain.

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.

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.

StreamName String Yes testStream

The name of the live stream.

Limit Integer No 10

The number of snapshots that you can obtain at a time when you call this operation. Valid values: 1 to 100. Default value: 10.

Order String No asc

The rule used to sort entries. Valid values:

  • asc: The entries are sorted in ascending order. This is the default value.
  • desc: The entries are sorted in descending order.

Response parameters

Parameter Type Example Description
RequestId String 62136AE6-7793-45ED-B14A-60D19A9486D3

The ID of the request.

LiveStreamSnapshotInfoList Array of LiveStreamSnapshotInfo

The snapshots.

LiveStreamSnapshotInfo
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.

OssBucket String livevideo-test

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

OssEndpoint String oss-cn-shanghai.aliyuncs.com

The endpoint of OSS.

OssObject String {AppName}/{StreamName}.jpg

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

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.

Examples

Sample requests

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
&<Common Request Parameters>

Sample success responses

XML format

<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 format

{
    "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"
}

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 earlier than the start time. 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 correct.

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