Queries snapshot jobs.
Operation description
The status of the snapshot jobs that you want to query.
- Submitted: The job was submitted.
- Snapshoting: The job is being processed.
- Success: The job was successfully processed.
- Fail: The job failed.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
SnapshotJobIds | string | No | The beginning of the time range within which the creation time of snapshot jobs to be queried is.
| 72dfa5e679ab4be9a3ed9974c736**** |
NextPageToken | string | No | The end of the time range within which the creation time of snapshot jobs to be queried is.
| cc6cbef8e8d5481ca536f5d2a466**** |
MaximumPageSize | long | No | The ID of the MPS queue to which the snapshot jobs that you want to query are submitted. To obtain the ID, you can log on to the MPS console and choose Global Settings > Pipelines in the left-side navigation pane. | 30 |
State | string | No | The information about the snapshot jobs. | Snapshoting |
StartOfJobCreatedTimeRange | string | No | The time when the job was created. | 2014-01-10T12:00:00Z |
EndOfJobCreatedTimeRange | string | No | The snapshot configuration. | 2014-01-12T12:00:00Z |
PipelineId | string | No | The start time for taking snapshots. Unit: milliseconds. | b11c171cced04565b1f38f1ecc39**** |
Response parameters
Examples
Sample success responses
JSON
format
{
"SnapshotJobList": {
"SnapshotJob": [
{
"CreationTime": "2021-06-30T12:34:29Z",
"SnapshotConfig": {
"Time": "4",
"TileOut": {
"Padding": "0",
"Color": "black",
"CellSelStep": "3",
"CellHeight": "8",
"CellWidth": "8",
"Margin": "0",
"Columns": "10",
"IsKeepCellPic": "false",
"Lines": "10"
},
"Interval": "10",
"FrameType": "intra",
"Width": "8",
"Height": "8",
"OutputFile": {
"RoleArn": "acs:ram::1:role/testrole",
"Object": "example.png",
"Location": "example-location",
"Bucket": "example"
},
"Num": "10",
"TileOutputFile": {
"RoleArn": "acs:ram::1:role/testrole",
"Object": "example.png",
"Location": "example-location",
"Bucket": "example"
}
},
"State": "Snapshoting",
"Message": "The resource operated InputFile is bad",
"MNSMessageResult": {
"MessageId": "799454621135656C7F815F198A76****",
"ErrorMessage": "The resource operated InputFile is bad",
"ErrorCode": "InvalidParameter"
},
"Input": {
"RoleArn": "acs:ram::1:role/testrole",
"Object": "example.flv",
"Location": "example-location",
"Bucket": "example"
},
"Count": "1",
"TileCount": "7",
"UserData": "testid-001",
"Code": "InvalidParameter",
"PipelineId": "b11c171cced04565b1f38f1ecc39****",
"Id": "cc6cbef8e8d5481ca536f5d2a466****"
}
]
},
"RequestId": "34BCAB31-2833-43A7-9FBD-B34302AB23EQ",
"NonExistSnapshotJobIds": {
"String": [
"c6d973c33d1c4b21bc39907d3b29****"
]
},
"NextPageToken": "b11c171cced04565b1f38f1ecc39****"
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-04-24 | The response structure of the API has changed | View Change Details |
2024-04-10 | The internal configuration of the API is changed, but the call is not affected | View Change Details |