DescribeLiveStreamSnapshotInfo - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the snapshots that were captured within a specific time period.

Operation description

You can query only snapshots that were captured in the last year.

QPS limit

You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.

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 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 time range specified by the EndTime and StartTime parameters 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 return per 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	asc

Response elements

Element	Type	Description	Example
	object
NextStartTime	string	The time when the next call occurred. 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 were captured within the specified time period exceeds the value of the Limit parameter, this parameter is returned. It indicates the time when the DescribeLiveStreamSnapshotInfo operation was called again. If this parameter is not returned, the number of snapshots that are captured within the specified time period does not exceed the specified limit.	2015-12-01T17:36:00Z
RequestId	string	The request ID.	62136AE6-7793-45ED-B14A-60D19A9486D3
LiveStreamSnapshotInfoList	object
LiveStreamSnapshotInfo	array<object>	The snapshots.
	object
OssObject	string	The name of the snapshot stored in Object Storage Service (OSS).	{liveApp**}/{liveStream**}.jpg
OssBucket	string	The name of the OSS bucket.	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 the OSS bucket.	cn-oss-****.aliyuncs.com
IsOverlay	boolean	The snapshot mode. Valid values: true: overwrite mode, which means that a new snapshot overwrites the previous snapshot. false: sequence mode, which means that a new snapshot does not overwrite the previous snapshot.	false
CreateTimestamp	integer	The timestamp when the snapshot file was created. Unit: 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.