ListLiveSnapshotJobs - - Alibaba Cloud Documentation Center

Retrieves a paginated list of live snapshot jobs.

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:ListLiveSnapshotJobs

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	No	The start of the time range to query. Specify the time in the ISO 8601 format: `yyyy-MM-ddTHH:mm:ssZ`. The time must be in UTC. If this parameter is not specified, the default is 7 days ago. The interval between `StartTime` and `EndTime` cannot exceed 30 days.	2022-02-02T00:00:00Z
EndTime	string	No	The end of the time range to query. Specify the time in the ISO 8601 format: `yyyy-MM-ddTHH:mm:ssZ`. The time must be in UTC. If this parameter is not specified, the default is the current time.	2022-02-02T23:59:59Z
SearchKeyWord	string	No	The search keyword. You can search by Job ID or Job Name. Fuzzy search is supported for Job Name. The maximum length is 128 characters.	**a046-263c-3560-978a-fb287782**
Status	string	No	The job status to filter by. If omitted, jobs of all statuses are returned. Valid values: init : The job has not started. paused : The job is paused. started : The job is running.
PageNo	integer	No	The page number to return. The value must be an integer greater than or equal to 1. Default value: 1.	1
PageSize	integer	No	The number of jobs to return on each page. Valid values: 1 to 100. Default value: 10.	10
SortBy	string	No	The sort order. The results are sorted by `CreateTime`. Default: `desc` (Descending). Valid values: asc : Ascending desc : Descending	desc

Response elements

Element	Type	Description	Example
	object	The data returned by the request.
RequestId	string	The request ID.	****11-DB8D-4A9A-875B-275798****
JobList	array<object>	The list of jobs.
	array<object>
JobId	string	The job ID.	**a046-263c-3560-978a-fb287782**
JobName	string	The job name.	Screenshot Task 1
TemplateId	string	The template ID.	**a046-263c-3560-978a-fb287666**
TemplateName	string	The template name.	Template 1
Status	string	The job status. Valid values: init : The job has not started. paused : The job is paused. started : The job is running.	started
SnapshotOutput	object	Details of the snapshot output.
StorageType	string	The storage type. Only Object Storage Service (OSS) is supported.	oss
Endpoint	string	The domain name of the OSS endpoint.	oss-cn-shanghai.aliyuncs.com
Bucket	string	The name of the OSS Bucket.	testbucket
TimeInterval	integer	The interval between snapshots, in seconds.	5
CreateTime	string	The creation time of the job.	2022-07-20T02:48:58Z
PageNo	integer	The page number.	1
PageSize	integer	The number of jobs to return per page.	10
SortBy	string	The sort order for the job list. For example, "desc" indicates descending order.	desc
TotalCount	integer	The total number of jobs found.	100

Examples

Success response

JSON format

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "JobList": [
    {
      "JobId": "****a046-263c-3560-978a-fb287782****",
      "JobName": "Screenshot task 1",
      "TemplateId": "****a046-263c-3560-978a-fb287666****",
      "TemplateName": "Template1",
      "Status": "started",
      "SnapshotOutput": {
        "StorageType": "oss",
        "Endpoint": "oss-cn-shanghai.aliyuncs.com",
        "Bucket": "testbucket"
      },
      "TimeInterval": 5,
      "CreateTime": "2022-07-20T02:48:58Z"
    }
  ],
  "PageNo": 1,
  "PageSize": 10,
  "SortBy": "desc",
  "TotalCount": 100
}

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.