调用QuerySnapshotJobList查询截图作业-阿里云帮助中心

使用说明

本接口一次最多查询10个截图作业。

QPS限制

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

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	QuerySnapshotJobList	操作接口名，系统规定参数，取值： QuerySnapshotJobList。
SnapshotJobIds	String	否	72dfa5e679ab4be9a3ed9974c736****	截图作业ID列表，可以通过MPS控制台>任务管理>截图获取。一次最多查询10个，半角逗号（,）分隔。
NextPageToken	String	否	cc6cbef8e8d5481ca536f5d2a466****	下一页标识，32位UUID。查询结果大于一页时返回，每次查询值都会更新。
MaximumPageSize	Long	否	30	每页最大返回数。默认值：30 。取值范围：[1,300]。
State	String	否	Snapshoting	需要查询的截图状态。 Submitted：已提交。 Snapshoting：截图中。 Success：截图成功。 Fail：截图失败。
StartOfJobCreatedTimeRange	String	否	2014-01-10T12:00:00Z	最早任务创建时间。日期格式按照ISO8601标准表示，并需要使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ 。
EndOfJobCreatedTimeRange	String	否	2014-01-12T12:00:00Z	最晚任务创建时间。日期格式按照ISO8601标准表示，并需要使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ 。
PipelineId	String	否	b11c171cced04565b1f38f1ecc39****	管道ID，可以通过MPS控制台>全局设置>管道获取。

返回数据


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

示例

请求示例

http(s)://mts.cn-hangzhou.aliyuncs.com/?Action=QuerySnapshotJobList
&SnapshotJobIds=72dfa5e679ab4be9a3ed9974c736****
&NextPageToken=cc6cbef8e8d5481ca536f5d2a466****
&MaximumPageSize=30
&State=Snapshoting
&StartOfJobCreatedTimeRange=2014-01-10T12:00:00Z
&EndOfJobCreatedTimeRange=2014-01-12T12:00:00Z
&PipelineId=b11c171cced04565b1f38f1ecc39****
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<QuerySnapshotJobListResponse>
    <SnapshotJobList>
        <CreationTime>2021-06-30T12:34:29Z</CreationTime>
        <SnapshotConfig>
            <Time>4</Time>
            <TileOut>
                <Padding>0</Padding>
                <Color>black</Color>
                <CellSelStep>3</CellSelStep>
                <CellHeight>8</CellHeight>
                <CellWidth>8</CellWidth>
                <Margin>0</Margin>
                <Columns>10</Columns>
                <IsKeepCellPic>false</IsKeepCellPic>
                <Lines>10</Lines>
            </TileOut>
            <Interval>10</Interval>
            <FrameType>intra</FrameType>
            <Width>8</Width>
            <Height>8</Height>
            <OutputFile>
                <RoleArn>acs:ram::1:role/testrole</RoleArn>
                <Object>example.png</Object>
                <Location>example-location</Location>
                <Bucket>example</Bucket>
            </OutputFile>
            <Num>10</Num>
            <TileOutputFile>
                <RoleArn>acs:ram::1:role/testrole</RoleArn>
                <Object>example.png</Object>
                <Location>example-location</Location>
                <Bucket>example</Bucket>
            </TileOutputFile>
        </SnapshotConfig>
        <State>Snapshoting</State>
        <MNSMessageResult>
            <MessageId>799454621135656C7F815F198A76****</MessageId>
        </MNSMessageResult>
        <Input>
            <RoleArn>acs:ram::1:role/testrole</RoleArn>
            <Object>example.flv</Object>
            <Location>example-location</Location>
            <Bucket>example</Bucket>
        </Input>
        <Count>1</Count>
        <TileCount>7</TileCount>
        <UserData>testid-001</UserData>
        <PipelineId>b11c171cced04565b1f38f1ecc39****</PipelineId>
        <Id>cc6cbef8e8d5481ca536f5d2a466****</Id>
    </SnapshotJobList>
    <RequestId>34BCAB31-2833-43A7-9FBD-B34302AB23EQ</RequestId>
    <NonExistSnapshotJobIds>c6d973c33d1c4b21bc39907d3b29****</NonExistSnapshotJobIds>
    <NextPageToken>b11c171cced04565b1f38f1ecc39****</NextPageToken>
</QuerySnapshotJobListResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
    "SnapshotJobList": [
        {
            "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",,
            "MNSMessageResult": {
                "MessageId": "799454621135656C7F815F198A76****",
            },
            "Input": {
                "RoleArn": "acs:ram::1:role/testrole",
                "Object": "example.flv",
                "Location": "example-location",
                "Bucket": "example"
            },
            "Count": "1",
            "TileCount": "7",
            "UserData": "testid-001",
            "PipelineId": "b11c171cced04565b1f38f1ecc39****",
            "Id": "cc6cbef8e8d5481ca536f5d2a466****"
        }
    ],
    "RequestId": "34BCAB31-2833-43A7-9FBD-B34302AB23EQ",
    "NonExistSnapshotJobIds": [
        "c6d973c33d1c4b21bc39907d3b29****"
    ],
    "NextPageToken": "b11c171cced04565b1f38f1ecc39****"
}

错误码

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