文档

QuerySnapshotJobList - 查询截图作业结果

更新时间:

查询截图作业。

接口说明

  • 您可以指定多个截图作业 ID(SnapshotJobIds)进行查询。或不指定具体的截图作业 ID,通过筛选截图状态、创建时间、管道等条件,进行分页查询。
  • 本接口一次最多查询 10 个截图作业。
  • 本接口返回值默认按 CreationTime 降序排列。

QPS 限制

本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
SnapshotJobIdsstring

截图作业 ID 列表。

  • 一次最多查询 10 个,半角逗号(,)分隔。
  • 可以通过 MPS 控制台>任务管理>截图获取,也可以从提交截图作业的返回参数中获取。
72dfa5e679ab4be9a3ed9974c736****
NextPageTokenstring

下一页标识,32 位 UUID。

  • 查询结果大于一页会返回 NextPageToken 参数,每次查询值都会更新。获取后请在下一次查询时填入。
cc6cbef8e8d5481ca536f5d2a466****
MaximumPageSizelong

分页查询每页最大返回数。

  • 取值范围:[1,300]
  • 默认值:30
30
Statestring

需要查询的截图状态。

  • Submitted:已提交。

  • Snapshoting:截图中。

  • Success:截图成功。

  • Fail:截图失败。

Snapshoting
StartOfJobCreatedTimeRangestring

最早任务创建时间。

  • 日期格式按照 ISO8601 标准表示,并需要使用 UTC 时间。
  • 格式为:YYYY-MM-DDThh:mm:ssZ 。
2014-01-10T12:00:00Z
EndOfJobCreatedTimeRangestring

最晚任务创建时间。

  • 日期格式按照 ISO8601 标准表示,并需要使用 UTC 时间。
  • 格式为:YYYY-MM-DDThh:mm:ssZ 。
2014-01-12T12:00:00Z
PipelineIdstring

管道 ID。详细信息请参见基本概念

  • 可选值:可以通过 MPS 控制台>全局设置>管道查询和创建。
  • 如果需要异步通知,请为管道绑定 MNS 消息,详细说明请参见接收消息通知
b11c171cced04565b1f38f1ecc39****

返回参数

名称类型描述示例值
object

返回参数。

SnapshotJobListobject []

截图作业列表。

CreationTimestring

任务创建时间。

2021-06-30T12:34:29Z
SnapshotConfigobject

截图配置。

Timestring

截图开始时间。单位:毫秒。

4
TileOutobject

拼图配置。

Paddingstring

图片间距。

  • 默认:0

  • 单位:px。

0
Colorstring

背景颜色。

  • 默认:black
  • 可取值范围:颜色关键字random
说明 其中颜色关键字支持三种格式,比如黑色,支持 Black,black,#000000。
black
CellSelStepstring

选取单图片步长。

3
CellHeightstring

单图片高度。默认截图输出分辨率高度。

8
CellWidthstring

单图片宽度。默认截图输出分辨率宽度。

8
Marginstring

外框宽度。

  • 默认:0

  • 单位:px。

0
Columnsstring

图片拼合列数。默认:10

10
IsKeepCellPicstring

是否保留单图片。默认:true

false
Linesstring

图片拼合行数。默认:10

10
Intervalstring

截图间隔时间。

  • 若指定则表示序列截图,且值大于 0。
  • 单位:秒。
  • 默认值:10
10
FrameTypestring

截图类型。

  • normal:普通帧。

  • intra:I 帧。

  • 默认值:intra

intra
Widthstring

截图输出图片宽度。

8
Heightstring

截图输出图片高度。

8
OutputFileobject

截图输出 OSS 配置。

RoleArnstring

指定角色的 ARN。格式:acs:ram::$accountID:role/$roleName。

acs:ram::1:role/testrole
Objectstring

截图输出文件 (OSS Object)。

example.png
Locationstring

截图输出 OSS Bucket 所在数据中心(OSS Location)。

example-location
Bucketstring

截图输出文件所在 OSS Bucket。

example
Numstring

截图数量。若指定则表示序列截图。

10
TileOutputFileobject

拼图任务大图的输出 OSS 配置。

RoleArnstring

指定角色的 ARN。格式:acs:ram::$accountID:role/$roleName。

acs:ram::1:role/testrole
Objectstring

输出文件 (OSS Object)。

example.png
Locationstring

输出 OSS Bucket 所在数据中心(OSS Location)。

example-location
Bucketstring

输出文件所在 OSS Bucket。

example
Statestring

截图状态。

  • Submitted:已提交。

  • Snapshoting:截图中。

  • Success:截图成功。

  • Fail:截图失败。

Snapshoting
Messagestring

分析失败时错误信息。如成功则不返回此消息。

The resource operated InputFile is bad
MNSMessageResultobject

MNS 通知用户作业完成的结果。

MessageIdstring

成功时消息 ID。如失败则不返回此参数。

799454621135656C7F815F198A76****
ErrorMessagestring

失败时错误信息。如成功则不返回此参数。

The resource operated InputFile is bad
ErrorCodestring

失败时错误码。如成功则不返回此参数。

InvalidParameter
Inputobject

作业输入。

RoleArnstring

指定角色的 ARN。格式:acs:ram::$accountID:role/$roleName。

acs:ram::1:role/testrole
Objectstring

输入文件 (OSS Object)。

example.flv
Locationstring

输入 OSS Bucket 所在数据中心(OSS Location)。

example-location
Bucketstring

输入文件所在 OSS Bucket。

example
Countstring

截取图片的数量。

1
TileCountstring

拼图图片数量。

7
UserDatastring

用户自定义数据。

testid-001
Codestring

分析失败时错误码。如成功则不返回此参数。

InvalidParameter
PipelineIdstring

管道 ID。

b11c171cced04565b1f38f1ecc39****
Idstring

截图作业 ID。

cc6cbef8e8d5481ca536f5d2a466****
RequestIdstring

请求 ID。

34BCAB31-2833-43A7-9FBD-B34302AB23EQ
NonExistSnapshotJobIdsarray

不存在的截图作业 ID 列表。

string

不存在的截图作业 ID 详情,无数据时该参数不返回。

c6d973c33d1c4b21bc39907d3b29****
NextPageTokenstring

下一页标识,32 位 UUID。查询结果大于一页时返回,每次查询值都会更新。

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****"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈