DescribeLiveStreamSnapshotInfo - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the snapshots that are captured within a specified period.

Operation description

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
live:DescribeLiveStreamSnapshotInfo	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The name of the main streaming domain.	example.com
AppName	string	Yes	The name of the application to which the live stream belongs.	liveApp****
StreamName	string	Yes	The name of the live stream.	liveStream****
StartTime	string	Yes	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.	2017-12-21T08:00:00Z
EndTime	string	Yes	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.	2017-12-22T08:00:00Z
Limit	integer	No	The number of snapshots to be returned upon one call. Valid values: 1 to 100. Default value: 10.	10
Order	string	No	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.	asc

Response parameters

Parameter	Type	Description	Example
	object
NextStartTime	string	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.	2015-12-01T17:36:00Z
RequestId	string	The ID of the request.	62136AE6-7793-45ED-B14A-60D19A9486D3
LiveStreamSnapshotInfoList	array<object>	The snapshots.
LiveStreamSnapshotInfo	object
OssObject	string	The name of the snapshot that is stored in an Object Storage Service (OSS) bucket.	{liveApp**}/{liveStream**}.jpg
OssBucket	string	The name of the OSS bucket in which the snapshot is stored.	liveBucket****
CreateTime	string	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.	2015-12-01T17:36:00Z
OssEndpoint	string	The endpoint of OSS.	cn-oss-****.aliyuncs.com
IsOverlay	boolean	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.	false
CreateTimestamp	long	The timestamp when the snapshot file was created. Unit: milliseconds.	1653641526637

Examples

Sample success responses

JSONformat

{
  "NextStartTime": "2015-12-01T17:36:00Z",
  "RequestId": "62136AE6-7793-45ED-B14A-60D19A9486D3",
  "LiveStreamSnapshotInfoList": {
    "LiveStreamSnapshotInfo": [
      {
        "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.	-
400	InvalidEndTime.Malformed	Specified parameter EndTime is not valid.	-
400	InvalidEndTime.Mismatch	Specified end time does not math the specified start time.	The end time does not match the start time. Make sure that the start and end times match.
400	InvalidStream.NotFound	Speicified stream does not exist.	-

For a list of error codes, visit the Service error codes.