Queries a list of live stream snapshot jobs by page.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ice:ListLiveSnapshotJobs | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| StartTime | string | No | 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 | No | 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.
| 2022-02-02T23:59:59Z |
| SearchKeyWord | string | No | The search keyword. You can use the job ID or name as the keyword to search for jobs. If you search for jobs by name, fuzzy match is supported.
| ****a046-263c-3560-978a-fb287782**** |
| Status | string | No | The job state filter. By default, all jobs are queried. Valid values:
| |
| PageNo | integer | No | The page number. Valid values: [1,n). Default value: 1. | 1 |
| PageSize | integer | No | The number of entries per page. Valid values: 1 to 100. Default value: 10. | 10 |
| SortBy | string | No | The sorting order. By default, the query results are sorted by creation time in descending order. Valid values:
| desc |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "******11-DB8D-4A9A-875B-275798******",
"JobList": [
{
"JobId": "****a046-263c-3560-978a-fb287782****",
"JobName": "",
"TemplateId": "****a046-263c-3560-978a-fb287666****",
"TemplateName": "",
"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. |
| 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. |
| 500 | InternalError | The request processing has failed due to some unknown error. |
For a list of error codes, visit the Service error codes.