查询截图作业。
接口说明
- 您可以指定多个截图作业ID(SnapshotJobIds)进行查询。或不指定具体的截图作业ID,通过筛选截图状态、创建时间、管道等条件,进行分页查询。
- 本接口一次最多查询10个截图作业。
- 本接口返回值默认按CreationTime降序排列。
QPS限制
本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
SnapshotJobIds | string | 否 | 72dfa5e679ab4be9a3ed9974c736**** | |
NextPageToken | string | 否 | 下一页标识,32位UUID。
| cc6cbef8e8d5481ca536f5d2a466**** |
MaximumPageSize | long | 否 | 分页查询每页最大返回数。
| 30 |
State | string | 否 | 需要查询的截图状态。
| Snapshoting |
StartOfJobCreatedTimeRange | string | 否 | 最早任务创建时间。
| 2014-01-10T12:00:00Z |
EndOfJobCreatedTimeRange | string | 否 | 最晚任务创建时间。
| 2014-01-12T12:00:00Z |
PipelineId | string | 否 | b11c171cced04565b1f38f1ecc39**** |
返回参数
示例
正常返回示例
JSON
格式
{
"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****"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史