tencent cloud

Feedback

Pulling Transcoding Jobs in Batches

Last updated: 2022-06-28 15:38:53

    Feature Description

    The API (DescribeMediaJobs) is used to pull jobs that meet specified conditions.

    Request

    Sample request

    GET /jobs?size=&states=&queueId=&startCreationTime=&endCreationTime= HTTP/1.1
    Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
    Date: <GMT Date>
    Authorization: <Auth String>
    
    Note:

    Authorization: Auth String (for more information, see Request Signature).

    Request headers

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

    Request body

    This request does not have a request body.

    Request parameters

    The nodes are as described below:

    Node Name (Keyword) Parent Node Description Type Required
    queueId None ID of the queue from which jobs are pulled String Yes
    tag None Job type: Transcode String Yes
    orderByTime None Desc (default) or Asc String No
    nextToken None Context token for pagination String No
    size None Maximum number of jobs that can be pulled. The default value is 10. The maximum value is 100. Integer No
    states None Status of the jobs to pull. If you enter multiple job statuses, separate them with commas (,). Valid values: All (default), Submitted, Running, Success, Failed, Pause, Cancel String No
    startCreationTime None Start time of the time range for job pulling in the format of %Y-%m-%dT%H:%m:%S%z, such as 2001-01-01T00:00:00+0800 String No
    endCreationTime None End time of the time range for job pulling in the format of %Y-%m-%dT%H:%m:%S%z, such as 2001-01-01T23:59:59+0800 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>
    </JobsDetail>
    <NextToken></NextToken>
    </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. Same as the Response.JobsDetail node in the CreateMediaJobs API. Container
    NextToken Response Context token for pagination String

    Error codes

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

    Use Cases

    Request

    GET /jobs?queueId=aaaaaaaaaaa&tag=Transcode 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
    

    Response

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Content-Length: 666
    Connection: keep-alive
    Date: Thu, 15 Jun 2017 12:37:29 GMT
    Server: tencent-ci
    x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzh****=
    <Response>
    <JobsDetail>
      <Code>Success</Code>
      <Message>Success</Message>
      <JobId>jabcxxxxfeipplsdfwe</JobId>
      <State>Submitted</State>
      <Progress>0</Progress>
      <CreationTime>2019-07-07T12:12:12+0800</CreationTime>
      <EndTime></EndTime>
      <QueueId>p893bcda225bf4945a378da6662e81a89</QueueId>
      <Tag>Transcode<Tag>
      <Input>
        <Object>test.mp4</Object>
      </Input>
      <Operation>
          <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
          <WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe22</WatermarkTemplateId>
          <WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe23</WatermarkTemplateId>
          <WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe24</WatermarkTemplateId>
          <DigitalWatermark>
            <State>Success</State>
            <Type>Text</Type>
            <Message>123456789ab</Message>
            <Version>V1</Version>
            <IgnoreError>false</IgnoreError>
          </DigitalWatermark>
          <Output>
              <Region>ap-beijing</Region>
              <Bucket>abc-1250000000</Bucket>
              <Object>test-trans.mp4</Object>
          </Output>
      </Operation>
    </JobsDetail>
    <JobsDetail>
      <Code>Success</Code>
      <Message>Success</Message>
      <JobId>jabcxxxxfeipplsdfwe</JobId>
      <State>Submitted</State>
      <Progress>0</Progress>
      <CreationTime>2019-07-07T12:12:12+0800</CreationTime>
      <EndTime></EndTime>
      <QueueId>p893bcda225bf4945a378da6662e81a89</QueueId>
      <Tag>Transcode<Tag>
      <Input>
        <Object>test.mp4</Object>
      </Input>
      <Operation>
          <Transcode>
              <Container>
                  <Format>mp4</Format>
              </Container>
              <Video>
                  <Codec>H.264</Codec>
                  <Profile>high</Profile>
                  <Bitrate>1000</Bitrate>
                  <Crf></Crf>
                  <Width>1280</Width>
                  <Height></Height>
                  <Fps>30</Fps>
                  <Gop></Gop>
                  <Preset>medium</Preset>
                  <ScanMode></ScanMode>
                  <Bufsize>0</Bufsize>
                  <Maxrate>0</Maxrate>
              </Video>
              <Audio>
                  <Codec>aac</Codec>
                  <Samplerate>44100</Samplerate>
                  <Bitrate>128</Bitrate>
                  <Channels>4</Channels>
              </Audio>
              <TransConfig>
                  <AdjDarMethod>rescale</AdjDarMethod>
                  <IsCheckReso>false</IsCheckReso>
                  <ResoAdjMethod>1</ResoAdjMethod>
              </TransConfig>
              <TimeInterval>
                  <Start>0</Start>
                  <Duration>60</Duration>
              </TimeInterval>
          </Transcode>
          <DigitalWatermark>
            <Type>Text</Type>
            <Message>123456789ab</Message>
            <Version>V1</Version>
            <IgnoreError>false</IgnoreError>
          </DigitalWatermark>
          <Output>
              <Region>ap-beijing</Region>
              <Bucket>abc-1250000000</Bucket>
              <Object>test-trans.mp4</Object>
          </Output>
      </Operation>
    </JobsDetail>
    </Response>
    
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support