ListLiveSnapshotFiles - - Alibaba Cloud Documentation Center

Queries a list of live stream snapshot files by page.

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

ice:ListLiveSnapshotFiles

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobId	string	Yes	The ID of the snapshot job.	**a046-263c-3560-978a-fb287782**
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.	2022-02-02T00:00:00Z
EndTime	string	Yes	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
Limit	integer	No	The number of results to return each time. Valid values: 1 to 100. Default value: 10.	10
SortBy	string	No	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. Valid values: asc : desc :	desc

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	****11-DB8D-4A9A-875B-275798****
FileList	array<object>	The list of files.
	object
OssEndpoint	string	The Object Storage Service (OSS) domain name.	oss-cn-shanghai.aliyuncs.com
OssBucket	string	The OSS bucket.	testbucket
OssObject	string	The location in which the OSS object is stored.	snapshot/**a046-263c-3560-978a-fb287782**/1660638613798.jpg
CreateTime	string	The time when the template was created.	2022-02-02T22:22:22Z
CreateTimestamp	integer	The creation timestamp that is used as an input parameter for a delete API operation.	1619503516000
IsOverlay	boolean	Specifies whether to overlay snapshots.	true
NextStartTime	string	The start time of the next page. If no value is returned, the pagination ends.	2022-02-02T22:22:22Z

Examples

Success response

JSON format

{
  "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 code	Error code	Error message
400	MissingParameter	%s
400	InvalidParameter	%s
400	MalformedStartTime	Specified parameter StartTime is not valid.
400	MalformedEndTime	Specified parameter EndTime is not valid.
400	EndTimeMismatch	Specified end time does not math the specified start time.
500	InternalError	The request processing has failed due to some unknown error.
403	UserDisable	User is disable.
403	Forbidden	User not authorized to operate on the specified resource.
403	OperationDenied	Your account has not enabled the ICE service.
404	JobNotFound	No such job.
404	NoValidSnapshot	No snapshots found with given parameters.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.