调用QuerySnapshotJobList接口查询截图作业-媒体处理-阿里云

查询截图作业。

接口说明

您可以指定多个截图作业 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	否	截图作业 ID 列表。一次最多查询 10 个，半角逗号（,）分隔。可以通过 MPS 控制台>任务管理>截图获取，也可以从提交截图作业的返回参数中获取。	72dfa5e679ab4be9a3ed9974c736****
NextPageToken	string	否	下一页标识，32 位 UUID。查询结果大于一页会返回 NextPageToken 参数，每次查询值都会更新。获取后请在下一次查询时填入。	cc6cbef8e8d5481ca536f5d2a466****
MaximumPageSize	integer	否	分页查询每页最大返回数。取值范围：[1,300]。默认值：30 。	30
State	string	否	需要查询的截图状态。 Submitted：已提交。 Snapshoting：截图中。 Success：截图成功。 Fail：截图失败。	Snapshoting
StartOfJobCreatedTimeRange	string	否	最早任务创建时间。日期格式按照 ISO8601 标准表示，并需要使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ 。	2014-01-10T12:00:00Z
EndOfJobCreatedTimeRange	string	否	最晚任务创建时间。日期格式按照 ISO8601 标准表示，并需要使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ 。	2014-01-12T12:00:00Z
PipelineId	string	否	管道 ID。详细信息请参见基本概念。可选值：可以通过 MPS 控制台>全局设置>管道查询和创建。如果需要异步通知，请为管道绑定 MNS 消息，详细说明请参见接收消息通知。	b11c171cced04565b1f38f1ecc39****

返回参数

名称	类型	描述	示例值
	object	返回参数。
SnapshotJobList	object
SnapshotJob	array<object>	截图作业列表。
	array<object>	返回参数。
CreationTime	string	任务创建时间。	2021-06-30T12:34:29Z
SnapshotConfig	object	截图配置。
Time	string	截图开始时间。单位：毫秒。	4
TileOut	object	拼图配置。
Padding	string	图片间距。默认：0。单位：px。	0
Color	string	背景颜色。默认：black。可取值范围：颜色关键字，random。说明其中颜色关键字支持三种格式，比如黑色，支持 Black，black，#000000。	black
CellSelStep	string	选取单图片步长。	3
CellHeight	string	单图片高度。默认截图输出分辨率高度。	8
CellWidth	string	单图片宽度。默认截图输出分辨率宽度。	8
Margin	string	外框宽度。默认：0。单位：px。	0
Columns	string	图片拼合列数。默认：10。	10
IsKeepCellPic	string	是否保留单图片。默认：true。	false
Lines	string	图片拼合行数。默认：10。	10
Interval	string	截图间隔时间。若指定则表示序列截图，且值大于 0。单位：秒。默认值：10。	10
FrameType	string	截图类型。 normal：普通帧。 intra：I 帧。默认值：intra。	intra
Width	string	截图输出图片宽度。	8
Height	string	截图输出图片高度。	8
OutputFile	object	截图输出 OSS 配置。
RoleArn	string	指定角色的 ARN。格式：acs:ram::$accountID:role/$roleName。	acs:ram::1:role/testrole
Object	string	截图输出文件（OSS Object）。	example.png
Location	string	截图输出 OSS Bucket 所在数据中心（OSS Location）。	example-location
Bucket	string	截图输出文件所在 OSS Bucket。	example
Num	string	截图数量。若指定则表示序列截图。	10
TileOutputFile	object	拼图任务大图的输出 OSS 配置。
RoleArn	string	指定角色的 ARN。格式：acs:ram::$accountID:role/$roleName。	acs:ram::1:role/testrole
Object	string	输出文件（OSS Object）。	example.png
Location	string	输出 OSS Bucket 所在数据中心（OSS Location）。	example-location
Bucket	string	输出文件所在 OSS Bucket。	example
TimeArray	object
TimePointList	array	指定时间点数组。
	integer	指定时间点数组，单位毫秒，浮点数，保留 2 位小数，可重复，可无序提交，由 MPS 排序。最多 100 个时间点。指定该参数时，Num、Time、Interval 均不指定。如指定则提示参数指定错误 InvalidParameter.Ambiguity。	[10050, 50000, 110000, 1000500, 1100500]
State	string	截图状态。 Submitted：已提交。 Snapshoting：截图中。 Success：截图成功。 Fail：截图失败。	Snapshoting
Message	string	分析失败时错误信息。如成功则不返回此消息。	The resource operated InputFile is bad
MNSMessageResult	object	MNS 通知用户作业完成的结果。
MessageId	string	成功时消息 ID。如失败则不返回此参数。	799454621135656C7F815F198A76****
ErrorMessage	string	失败时错误信息。如成功则不返回此参数。	The resource operated InputFile is bad
ErrorCode	string	失败时错误码。如成功则不返回此参数。	InvalidParameter
Input	object	作业输入。
RoleArn	string	指定角色的 ARN。格式：acs:ram::$accountID:role/$roleName。	acs:ram::1:role/testrole
Object	string	输入文件（OSS Object）。	example.flv
Location	string	输入 OSS Bucket 所在数据中心（OSS Location）。	example-location
Bucket	string	输入文件所在 OSS Bucket。	example
Count	string	截取图片的数量。	1
TileCount	string	拼图图片数量。	7
UserData	string	用户自定义数据。	testid-001
Code	string	分析失败时错误码。如成功则不返回此参数。	InvalidParameter
PipelineId	string	管道 ID。	b11c171cced04565b1f38f1ecc39****
Id	string	截图作业 ID。	cc6cbef8e8d5481ca536f5d2a466****
RequestId	string	请求 ID。	34BCAB31-2833-43A7-9FBD-B34302AB23EQ
NonExistSnapshotJobIds	object
String	array	不存在的截图作业 ID 列表。
	string	不存在的截图作业 ID 详情，无数据时该参数不返回。	c6d973c33d1c4b21bc39907d3b29****
NextPageToken	string	下一页标识，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"
          },
          "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****"
}

错误码

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

变更历史

更多信息，参考变更详情。