Query Live Stream Snapshots via DescribeLiveStreamSnapshotInfo - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Queries snapshot content within a specified time range.

Operation description

You can call this operation to query snapshot data only within the last year.

QPS limit

The single-user QPS limit for this operation is 100 calls per second. If this limit is exceeded, the API calls are throttled, which may affect your business. Call this operation appropriately.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:DescribeLiveStreamSnapshotInfo

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The streaming domain of the streamer. Note When you specify DomainName, make sure that the domain name is a live streaming domain name and that the user who calls this operation has the permissions to operate on the specified domain name.	example.com
AppName	string	Yes	The name of the application to which the stream belongs.	liveApp****
StreamName	string	Yes	The name of the stream. Make sure that the specified stream name exists within the query time range.	liveStream****
StartTime	string	Yes	The start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2017-12-21T08:00:00Z
EndTime	string	Yes	The end time. The interval between EndTime and StartTime cannot exceed 1 day. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2017-12-22T08:00:00Z
Limit	integer	No	The number of entries to return in a single call. Valid values: 1 to 100. Default value: 10.	10
Order	string	No	The sort order. Valid values: asc (default): ascending order. desc: descending order. Valid values: asc : ascending order. desc : descending order.	asc

Response elements

Element	Type	Description	Example
	object
NextStartTime	string	The next start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC). Note If the content within this time range exceeds the value of Limit, this parameter is returned as the creation time of the next file. You can use this time as the StartTime value and call this operation again to retrieve the next set of content. If this parameter is not returned, the content does not exceed the Limit value.	2015-12-01T17:36:00Z
RequestId	string	The request ID.	62136AE6-7793-45ED-B14A-60D19A9486D3
LiveStreamSnapshotInfoList	object
LiveStreamSnapshotInfo	array<object>	The list of snapshot content.
	object
OssObject	string	The name of the file stored in OSS.	{liveApp**}/{liveStream**}.jpg
OssBucket	string	The name of the OSS bucket.	liveBucket****
CreateTime	string	The time when the snapshot was taken. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2015-12-01T17:36:00Z
OssEndpoint	string	The endpoint of the OSS bucket.	cn-oss-****.aliyuncs.com
IsOverlay	boolean	The snapshot mode. Valid values: true: overwrite snapshot. false: sequential snapshot.	false
CreateTimestamp	integer	The timestamp when the snapshot file was created, in milliseconds.	1653641526637

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.