tencent cloud

masukan

Submitting Screenshot Job

Terakhir diperbarui:2022-08-19 15:16:47

    Feature Description

    This API is used to submit a screenshot job.

    API Explorer is recommended.
    Click to debug
    Tencent Cloud API Explorer provides various capabilities such as online call, signature verification, SDK code generation, and quick API search. You can also use it to query the request and response of each API call as well as generate sample code for calls.

    Request

    Sample request

    POST /jobs HTTP/1.1
    Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
    Date: <GMT Date>
    Authorization: <Auth String>
    Content-Length: <length>
    Content-Type: application/xml
    <body>
    
    Note:

    • Authorization: Auth String (for more information, see Request Signature).
    • When this feature is used by a sub-account, relevant permissions must be granted.

    Request headers

    This API only uses common request headers. For more information, see Common Request Headers.

    Request body

    This request requires the following request body:

    <Request>
      <Tag>Snapshot</Tag>
      <Input>
          <Object>input/demo.mp4</Object>
      </Input>
      <Operation>
          <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
          <Output>
              <Region>ap-chongqing</Region>
              <Bucket>test-123456789</Bucket>
              <Object>output/snapshot-${Number}.jpg</Object>
              <SpriteObject>output/sprite-${Number}.jpg</SpriteObject>
          </Output>
          <UserData>This is my data.</UserData>
      </Operation>
      <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
      <CallBack>http://callback.demo.com</CallBack>
      <CallBackFormat>JSON<CallBackFormat>
    </Request>
    

    The nodes are described as follows:

    Node Name (Keyword) Parent Node Description Type Required
    Request None Request container Container Yes

    Request has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type Required
    Tag Request Job type: Snapshot String Yes
    Input Request Information of the media file to be processed Container Yes
    Operation Request Operation rule Container Yes
    QueueId Request Queue ID of the job String Yes
    CallBack Request Job callback address, which has a higher priority than that of the queue. If it is set to no, no callbacks will be generated at the callback address of the queue. String No
    CallBackFormat Request Job callback format, which can be JSON or XML (default value). It has a higher priority than that of the queue. String No

    Input has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type Required
    Object Request.Input Media filename String Yes


    Operation has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type Required
    Snapshot Request.Operation Job type parameter. Same as Request.Snapshot in the screenshot template creation API CreateMediaTemplate. Container No
    TemplateId Request.Operation Template ID String No
    Output Request.Operation Result output address Container Yes
    UserData Request.Operation The user information passed through, which is printable ASCII codes of up to 1,024 in length. String No
    Note:

    TemplateId is used first. If TemplateId is unavailable, Snapshot is used.

    Output has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type Required
    Region Request.Operation.Output Bucket region String Yes
    Bucket Request.Operation.Output Result storage bucket String Yes
    Object Request.Operation.Output Result filename. ${Number} must be included in the filename. For example, you can set Object to snapshot-${Number}.jpg. String No
    SpriteObject Request.Operation.Output Image sprite name. ${Number} must be included in the filename. *For example, you can set sprite-${Number}.jpg.\* Only the .jpg format is supported. String No

    Response

    Response headers

    This API only returns common response headers. For more information, see Common Response Headers.

    Response body

    The response body returns application/xml data. The following contains all the nodes:

    <Response>
      <JobsDetail>
          <Code>Success</Code>
          <Message/>
          <JobId>j8d121820f5e411ec926ef19d53ba9c6f</JobId>
          <State>Submitted</State>
          <CreationTime>2022-06-27T15:23:10+0800</CreationTime>
          <StartTime>-</StartTime>
          <EndTime>-</EndTime>
          <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
          <Tag>Snapshot</Tag>
          <Input>
              <BucketId>test-123456789</BucketId>
              <Object>input/demo.mp4</Object>
              <Region>ap-chongqing</Region>
          </Input>
          <Operation>
              <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
              <TemplateName>snapshot_demo</TemplateName>
              <Output>
                  <Region>ap-chongqing</Region>
                  <Bucket>test-123456789</Bucket>
                  <Object>output/snapshot-${Number}.jpg</Object>
                  <SpriteObject>output/sprite-${Number}.jpg</SpriteObject>
              </Output>
              <UserData>This is my data.</UserData>
          </Operation>
      </JobsDetail>
    </Response>
    

    The nodes are as described below:

    Node Name (Keyword) Parent Node Description Type
    Response None Response container Container

    Response has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    JobsDetail Response Job details Container


    JobsDetail has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    Code Response.JobsDetail Error code, which is returned only if State is Failed String
    Message Response.JobsDetail Error message, which is returned only if State is Failed String
    JobId Response.JobsDetail Job ID String
    Tag Response.JobsDetail Job type: Snapshot String
    State Response.JobsDetail Job status. Valid values: Submitted, Running, Success, Failed, Pause, Cancel. String
    CreationTime Response.JobsDetail Job creation time String
    StartTime Response.JobsDetail Job start time String
    EndTime Response.JobsDetail Job end time String
    QueueId Response.JobsDetail ID of the queue which the job is in String
    Input Response.JobsDetail Input resource address of the job Container
    Operation Response.JobsDetail Operation rule Container

    Input has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    Region Response.JobsDetail.Input Bucket region String
    Bucket Response.JobsDetail.Input Result storage bucket String
    Object Response.JobsDetail.Input Output result filename String

    Operation has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    TemplateId Response.JobsDetail.Operation Job template ID String
    TemplateName Response.JobsDetail.Operation Job template name, which will be returned if TemplateId exists. String
    Snapshot Response.JobsDetail.Operation Same as Request.Operation.Snapshot in the request. Container
    Output Response.JobsDetail.Operation Same as Request.Operation.Output in the request. Container
    MediaResult Response.JobsDetail.Operation Basic information of the output file, which will not be returned when the job is not completed. Container
    UserData Response.JobsDetail.Operation The user information passed through. String

    MediaResult has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    OutputFile Response.Operation.MediaResult Basic information of the output file. Container

    OutputFile has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    Bucket Response.Operation.MediaResult.OutputFile Bucket of the output file. String
    Region Response.Operation.MediaResult.OutputFile Bucket region of the output file. String
    ObjectName Response.Operation.MediaResult.OutputFile Output filename. There may be multiple values. String array
    Md5Info Response.Operation.MediaResult.OutputFile MD5 information of the output file. Container array

    Md5Info has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    ObjectName Response.Operation.MediaResult.OutputFile.Md5Info Output filename. String
    Md5 Response.Operation.MediaResult.OutputFile.Md5Info MD5 value of the output file. Container

    Error codes

    There are no special error messages for this request. For common error messages, see Error Codes.

    Samples

    Request 1. Using the screenshot template ID

    POST /jobs HTTP/1.1
    Authorization:q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0ea057
    Host:bucket-1250000000.ci.ap-beijing.myqcloud.com
    Content-Length: 166
    Content-Type: application/xml
    <Request>
      <Tag>Snapshot</Tag>
      <Input>
          <Object>input/demo.mp4</Object>
      </Input>
      <Operation>
          <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
          <Output>
              <Region>ap-chongqing</Region>
              <Bucket>test-123456789</Bucket>
              <Object>output/snapshot-${Number}.jpg</Object>
              <SpriteObject>output/sprite-${Number}.jpg</SpriteObject>
          </Output>
          <UserData>This is my data.</UserData>
      </Operation>
      <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
      <CallBack>http://callback.demo.com</CallBack>
      <CallBackFormat>JSON<CallBackFormat>
    </Request>
    

    Response

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Content-Length: 230
    Connection: keep-alive
    Date: Mon, 28 Jun 2022 15:23:12 GMT
    Server: tencent-ci
    x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzh****=
    <Response>
      <JobsDetail>
          <Code>Success</Code>
          <Message/>
          <JobId>j8d121820f5e411ec926ef19d53ba9c6f</JobId>
          <State>Submitted</State>
          <CreationTime>2022-06-27T15:23:10+0800</CreationTime>
          <StartTime>-</StartTime>
          <EndTime>-</EndTime>
          <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
          <Tag>Snapshot</Tag>
          <Input>
              <BucketId>test-123456789</BucketId>
              <Object>input/demo.mp4</Object>
              <Region>ap-chongqing</Region>
          </Input>
          <Operation>
              <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
              <TemplateName>snapshot_demo</TemplateName>
              <Output>
                  <Region>ap-chongqing</Region>
                  <Bucket>test-123456789</Bucket>
                  <Object>output/snapshot-${Number}.jpg</Object>
                  <SpriteObject>output/sprite-${Number}.jpg</SpriteObject>
              </Output>
              <UserData>This is my data.</UserData>
          </Operation>
      </JobsDetail>
    </Response>
    

    Request 2. Using the screenshot processing parameter

    POST /jobs HTTP/1.1
    Authorization:q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0ea057
    Host:bucket-1250000000.ci.ap-beijing.myqcloud.com
    Content-Length: 166
    Content-Type: application/xml
    <Request>
      <Tag>Snapshot</Tag>
      <Input>
          <Object>input/demo.mp4</Object>
      </Input>
      <Operation>
          <Snapshot>
              <BlackLevel>0</BlackLevel>
              <Count>10</Count>
              <IsCheckBlack>false</IsCheckBlack>
              <IsCheckCount>false</IsCheckCount>
              <Mode>Interval</Mode>
              <PixelBlackThreshold>0</PixelBlackThreshold>
              <SnapshotOutMode>SnapshotAndSprite</SnapshotOutMode>
              <SpriteSnapshotConfig>
                  <Color>Azure</Color>
                  <Columns>3</Columns>
                  <Lines>2</Lines>
              </SpriteSnapshotConfig>
              <Start>1</Start>
              <TimeInterval>2</TimeInterval>
          </Snapshot>
          <Output>
              <Region>ap-chongqing</Region>
              <Bucket>test-123456789</Bucket>
              <Object>output/snapshot-${Number}.jpg</Object>
              <SpriteObject>output/sprite-${Number}.jpg</SpriteObject>
          </Output>
          <UserData>This is my data.</UserData>
      </Operation>
      <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
      <CallBack>http://callback.demo.com</CallBack>
      <CallBackFormat>JSON<CallBackFormat>
    </Request>
    

    Response

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Content-Length: 230
    Connection: keep-alive
    Date: Mon, 28 Jun 2022 15:23:12 GMT
    Server: tencent-ci
    x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzh****=
    <Response>
      <JobsDetail>
          <Code>Success</Code>
          <Message/>
          <JobId>j8d121820f5e411ec926ef19d53ba9c6f</JobId>
          <State>Submitted</State>
          <CreationTime>2022-06-27T15:23:10+0800</CreationTime>
          <StartTime>-</StartTime>
          <EndTime>-</EndTime>
          <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
          <Tag>Snapshot</Tag>
          <Input>
              <BucketId>test-123456789</BucketId>
              <Object>input/demo.mp4</Object>
              <Region>ap-chongqing</Region>
          </Input>
          <Operation>
              <Snapshot>
                  <BlackLevel>0</BlackLevel>
                  <Count>10</Count>
                  <IsCheckBlack>false</IsCheckBlack>
                  <IsCheckCount>false</IsCheckCount>
                  <Mode>Interval</Mode>
                  <PixelBlackThreshold>0</PixelBlackThreshold>
                  <SnapshotOutMode>SnapshotAndSprite</SnapshotOutMode>
                  <SpriteSnapshotConfig>
                      <Color>Azure</Color>
                      <Columns>3</Columns>
                      <Lines>2</Lines>
                  </SpriteSnapshotConfig>
                  <Start>1</Start>
                  <TimeInterval>2</TimeInterval>
              </Snapshot>
              <Output>
                  <Region>ap-chongqing</Region>
                  <Bucket>test-123456789</Bucket>
                  <Object>output/snapshot-${Number}.jpg</Object>
                  <SpriteObject>output/sprite-${Number}.jpg</SpriteObject>
              </Output>
              <UserData>This is my data.</UserData>
          </Operation>
      </JobsDetail>
    </Response>
    
    Hubungi Kami

    Hubungi tim penjualan atau penasihat bisnis kami untuk membantu bisnis Anda.

    Dukungan Teknis

    Buka tiket jika Anda mencari bantuan lebih lanjut. Tiket kami tersedia 7x24.

    Dukungan Telepon 7x24