All Products
Search
Document Center

Intelligent Media Services:ListLiveSnapshotFiles

Last Updated:Dec 16, 2024

Queries a list of live stream snapshot files by page.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
ice:ListLiveSnapshotFiles
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
JobIdstringYes

The ID of the snapshot job.

****a046-263c-3560-978a-fb287782****
StartTimestringYes

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.

2022-02-02T00:00:00Z
EndTimestringYes

The end 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.

  • The maximum time range that can be specified is one day.
2022-02-02T23:59:59Z
LimitintegerNo

The number of results to return each time. Valid values: 1 to 100. Default value: 10.

10
SortBystringNo

The sorting order. Default value: asc.

Valid values:

  • asc: sorts the query results by creation time in ascending order.
  • desc: sorts the query results by creation time in descending order.
desc

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

RequestIdstring

The request ID.

******11-DB8D-4A9A-875B-275798******
FileListarray<object>

The list of files.

Snapshotobject
OssEndpointstring

The Object Storage Service (OSS) domain name.

oss-cn-shanghai.aliyuncs.com
OssBucketstring

The OSS bucket.

testbucket
OssObjectstring

The location in which the OSS object is stored.

snapshot/****a046-263c-3560-978a-fb287782****/1660638613798.jpg
CreateTimestring

The time when the template was created.

2022-02-02T22:22:22Z
CreateTimestamplong

The creation timestamp that is used as an input parameter for a delete API operation.

1619503516000
IsOverlayboolean

Specifies whether to overlay snapshots.

true
NextStartTimestring

The start time of the next page. If no value is returned, the pagination ends.

2022-02-02T22:22:22Z

Examples

Sample success responses

JSONformat

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "FileList": [
    {
      "OssEndpoint": "oss-cn-shanghai.aliyuncs.com",
      "OssBucket": "testbucket",
      "OssObject": "snapshot/****a046-263c-3560-978a-fb287782****/1660638613798.jpg",
      "CreateTime": "2022-02-02T22:22:22Z",
      "CreateTimestamp": 1619503516000,
      "IsOverlay": true
    }
  ],
  "NextStartTime": "2022-02-02T22:22:22Z"
}

Error codes

HTTP status codeError codeError message
400MissingParameter%s
400InvalidParameter%s
400MalformedStartTimeSpecified parameter StartTime is not valid.
400MalformedEndTimeSpecified parameter EndTime is not valid.
400EndTimeMismatchSpecified end time does not math the specified start time.
403UserDisableUser is disable.
403ForbiddenUser not authorized to operate on the specified resource.
403OperationDeniedYour account has not enabled the ICE service.
404JobNotFoundNo such job.
404NoValidSnapshotNo snapshots found with given parameters.
500InternalErrorThe request processing has failed due to some unknown error.

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