查询截图作业。
接口说明
- 您可以指定多个截图作业 ID（SnapshotJobIds）进行查询。或不指定具体的截图作业 ID，通过筛选截图状态、创建时间、管道等条件，进行分页查询。
- 本接口一次最多查询 10 个截图作业。
- 本接口返回值默认按 CreationTime 降序排列。
QPS 限制
本接口的单用户 QPS 限制为 100 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 QPS 限制。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| mts:QuerySnapshotJobList | list |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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"
},
"TimeArray": {
"TimePointList": [
0
]
}
},
"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****"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-04-24 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-04-10 | API 内部配置变更，不影响调用 | 查看变更详情 |