edit-icon download-icon

QuerySnapshotJobList

Last Updated: Feb 08, 2018

Description

After screenshot tasks are submitted, Media Processing asynchronously takes screenshots. This API can be used to query the screenshot task results.

Request parameters

Parameter Type Required or not Description
Action String Yes API of the action, system required parameter. Set this parameter to QuerySnapshotJobList.
SnapshotJobIds String Yes List of screenshot task IDs. A maximum of 10 screenshot task IDs can be entered.

Return parameters

Name Type Description
SnapshotJobList AliyunSnapshotJob[] List of screenshot tasks
NonExistSnapshotJobIds String[] List of non-existing screenshot task IDs. If no data exists, this structure is not returned.

Example

Request example

  1. http://mts.cn-hangzhou.aliyuncs.com?Action=QuerySnapshotJobList&SnapshotJobIds=88c6ca184c0e47098a5b665e2a126797&<Public parameter>

Return example

XML

  1. <QuerySnapshotJobListResponse>
  2. <RequestId>
  3. 25818875-5F78-4A13-BEF6-D7393642CA58
  4. </RequestId>
  5. <SnapshotJobList list="true">
  6. <SnapshotJob>
  7. <Id>88c6ca184c0e47098a5b665e2a126797</Id>
  8. <State>Success</State>
  9. <Code> </Code>
  10. <Message> </Message>
  11. <SnapshotConfig>
  12. <OutputFile>
  13. <Bucket>example-001</Bucket>
  14. <Location>oss-cn-hangzhou</Location>
  15. <Object>example.png</Object>
  16. </OutputFile>
  17. <Time>4</Time>
  18. </SnapshotConfig>
  19. <PipelineId>88c6ca184c0e47098a5b665e2a126797</PipelineId>
  20. <UserData>testid-001</UserData>
  21. <CreationTime>2014-01-10T12:00:00Z</CreationTime>
  22. </SnapshotJob>
  23. </SnapshotJobList>
  24. </QuerySnapshotJobListResponse>

JSON

  1. {
  2. "RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
  3. "SnapshotJobList": {
  4. "SnapshotJob": [{
  5. "Id": "88c6ca184c0e47098a5b665e2a126797",
  6. "State": "Success",
  7. "Code": "",
  8. "Message": "",
  9. "SnapshotConfig": {
  10. "OutputFile": {
  11. "Bucket": "example-001",
  12. "Location": "oss-cn-hangzhou",
  13. "Object": "example.png "
  14. },
  15. "Time": "5"
  16. },
  17. "PipelineId": "88c6ca184c0e47098a5b665e2a126797",
  18. "UserData": "testid-001",
  19. "CreationTime": "2014-01-10T12:00:00Z"
  20. }]
  21. }
  22. }
Thank you! We've received your feedback.