tencent cloud

Feedback

Pulling Transcoding Tasks in Batches

Last updated: 2021-12-31 17:20:40

    Feature Description

    The API (DescribeMediaJobs) is used to pull tasks 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, please see Request Signature.)

    Request headers

    This API only uses Common Request Headers.

    Request body

    This request does not have a request body.

    Request parameters

    The nodes are described as follows:

    Node Name (Keyword) Parent Node Description Type Required
    QueueId None ID of the queue from which tasks are pulled String Yes
    Tag None Task 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 tasks pulled. The default value is 10. The maximum value is 100. Integer No
    States None Status of the tasks to pull. If you enter multiple task states, 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 task pulling. Format: %Y-%m-%dT%H:%m:%S%z. Example: 2001-01-01T00:00:00+0800 String No
    EndCreationTime None End time of the time range for task pulling. Format: %Y-%m-%dT%H:%m:%S%z. Example: 2001-01-01T23:59:59+0800 String No

    Response

    Response headers

    This API only returns 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 described as follows:

    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 Task details. Same as the Response.JobsDetail node in the CreateMediaJobs API. Container
    NextToken Response Context token for pagination String

    JobsDetail has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    Code Response.JobsDetail Error code, which is meaningful only if State is Failed String
    Message Response.JobsDetail Error description, which is meaningful only if State is Failed String
    JobId Response.JobsDetail Task ID String
    Tag Response.JobsDetail Task type: Transcode String
    State Response.JobsDetail Task status. Valid values: Submitted, Running, Success, Failed, Pause, Cancel String
    CreationTime Response.JobsDetail Task creation time String
    StartTime Response.JobsDetail Task start time String
    EndTime Response.JobsDetail Task end time String
    QueueId Response.JobsDetail ID of the queue where the task is in String
    Input Response.JobsDetail Input resource address of the task Container
    Operation Response.JobsDetail Operation rule. Up to 6 operation rules are supported. Container

    Operation has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    Transcode Response.JobsDetail.Operation Transcoding template parameters Container
    Watermark Response.JobsDetail.Operation Watermark template parameters. Same as Request.Watermark in the watermark template creation API CreateMediaTemplate. Container
    TemplateId Response.JobsDetail.Operation Template ID String
    WatermarkTemplateId Response.JobsDetail.Operation Watermark template ID. Multiple watermark template IDs are supported. String
    Output Response.JobsDetail.Operation Result output address Container
    Note:

    TemplateId is used with priority. If TemplateId is unavailable, the corresponding task type parameter is used.

    Transcode has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    Container Response.JobsDetail.Operation.Transcode Same as Request.Container in the transcoding template creation API CreateMediaTemplate. Container
    Video Response.JobsDetail.Operation.Transcode Same as Request.Video in the transcoding template creation API CreateMediaTemplate. Container
    TimeInterval Response.JobsDetail.Operation.Transcode Same as Request.TimeInterval in the transcoding template creation API CreateMediaTemplate. Container
    Audio Response.JobsDetail.Operation.Transcode Same as Request.Audio in the transcoding template creation API CreateMediaTemplate. Container
    TransConfig Response.JobsDetail.Operation.Transcode Same as Request.TransConfig in the transcoding template creation API CreateMediaTemplate. Container

    Output has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    Region Response.JobsDetail.Operation.Output Bucket region String
    Bucket Response.JobsDetail.Operation.Output Result storage bucket String
    Object Response.JobsDetail.Operationn.Output Result file name String

    Error codes

    No special error message will be returned for this request. For the common error messages, please see Error Codes.

    Examples

    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>
      <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>
          <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>
      <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>
          <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