提交截图作业

• 异步模式：不保证接口返回时截图已经生成，截图任务将进入后台排队，异步执行截图。只要设置了Interval和Num中的任何一个参数，就表示异步模式。
• 消息通知：提交截图作业时，PipelineId参数必填，只有在管道上指定了回调信息，完成后才会发送异步消息。

请求参数

返回数据

示例

请求示例

http(s)://UpdatePipeline/?Action=SubmitSnapshotJob
&Input={"Bucket":"example-bucket", "Location":"oss-cn-hangzhou","Object":"example.flv"}
&SnapshotConfig={"OutputFile":{"Bucket":"example-001","Location":"oss-cn-hangzhou","Object":"{Count}.jpg"},"Time":"5","Num":"10","Interval":"20"}
&UserData=testid-001
&PipelineId=dd3dae411e704030b921e52698e5****
&<公共请求参数>

正常返回示例

XML格式

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

<SubmitSnapshotJobResponse>
    <RequestId>19B6D8C5-A5DD-467A-B435-29D393C71E2D</RequestId>
    <SnapshotJob>
        <CreationTime>2021-05-19T03:11:48Z</CreationTime>
        <SnapshotConfig>
            <Time>4</Time>
            <TileOut>
                <Padding>0</Padding>
                <Color>black</Color>
                <CellSelStep>3</CellSelStep>
                <CellHeight>100</CellHeight>
                <CellWidth>100</CellWidth>
                <Margin>5</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>oss-cn-hangzhou</Location>
                <Bucket>example-001</Bucket>
            </OutputFile>
            <Num>10</Num>
            <TileOutputFile>
                <RoleArn>acs:ram::1:role/testrole</RoleArn>
                <Object>example.png</Object>
                <Location>oss-cn-hangzhou</Location>
                <Bucket>example-001</Bucket>
            </TileOutputFile>
        </SnapshotConfig>
        <State>Snapshoting</State>
        <Message>The resource operated InputFile is bad</Message>
        <MNSMessageResult>
            <MessageId>799454621135656C7F815F198A76****</MessageId>
            <ErrorMessage>The resource operated InputFile is bad</ErrorMessage>
            <ErrorCode>InvalidParameter</ErrorCode>
        </MNSMessageResult>
        <Input>
            <RoleArn>acs:ram::1:role/testrole</RoleArn>
            <Object>example.flv</Object>
            <Location>oss-cn-hangzhou</Location>
            <Bucket>example-001</Bucket>
        </Input>
        <Count>1</Count>
        <TileCount>5</TileCount>
        <UserData>testid-001</UserData>
        <Code>ResourceContentBad</Code>
        <PipelineId>dd3dae411e704030b921e52698e5****</PipelineId>
        <Id>f4e3b9ba9f3840c39d6e288056f0****</Id>
    </SnapshotJob>
</SubmitSnapshotJobResponse>

JSON格式

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

{
  "RequestId" : "19B6D8C5-A5DD-467A-B435-29D393C71E2D",
  "SnapshotJob" : {
    "CreationTime" : "2021-05-19T03:11:48Z",
    "SnapshotConfig" : {
      "Time" : "4",
      "TileOut" : {
        "Padding" : "0",
        "Color" : "black",
        "CellSelStep" : "3",
        "CellHeight" : "100",
        "CellWidth" : "100",
        "Margin" : "5",
        "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" : "oss-cn-hangzhou",
        "Bucket" : "example-001"
      },
      "Num" : "10",
      "TileOutputFile" : {
        "RoleArn" : "acs:ram::1:role/testrole",
        "Object" : "example.png",
        "Location" : "oss-cn-hangzhou",
        "Bucket" : "example-001"
      }
    },
    "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" : "oss-cn-hangzhou",
      "Bucket" : "example-001"
    },
    "Count" : "1",
    "TileCount" : "5",
    "UserData" : "testid-001",
    "Code" : "ResourceContentBad",
    "PipelineId" : "dd3dae411e704030b921e52698e5****",
    "Id" : "f4e3b9ba9f3840c39d6e288056f0****"
  }
}

错误码

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