tencent cloud

Feedback

Submitting Media Information Query Job

Last updated: 2022-05-23 11:52:22

    Overview

    This API (CreateMediaJobs) is used to submit a task.

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

    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>MediaInfo</Tag>
    <Input>
      <Object></Object>
    </Input>
    <QueueId></QueueId>
    <CallBack></CallBack>
    </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 Task type: MediaInfo String Yes
    Input Request Information of the media file to be processed Container Yes
    QueueId Request Queue ID of the task String Yes
    CallBack Request Callback address String No

    Input has the following sub-nodes:

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

    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></Code>
      <Message></Message>
      <JobId></JobId>
      <State></State>
      <CreationTime></CreationTime>
      <StartTime></StartTime>
      <EndTime></EndTime>
      <QueueId></QueueId>
      <Tag>MediaInfo</Tag>
      <Input>
        <Object></Object>
      </Input>
      <Operation>
        <MediaInfo>
        </MeidaInfo>
      </Operation>
    </JobsDetail>
    </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 Container

    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: MediaInfo 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 Queue ID of the task String
    Input Response.JobsDetail Input resource address of the task Container
    Operation Response.JobsDetail Operation rule. Up to six operation rules are supported. Container

    Input has the following sub-nodes:
    Same as the Request.Input node in the request.

    Operation has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    MediaInfo Response.JobsDetail.Operation Output video information. Not returned when the task is not completed. Container

    MediaInfo has the following sub-nodes:
    Same as the Response.MediaInfo node in the GenerateMediaInfo API.

    Error codes

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

    Use Cases

    Request

    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: examplebucket-1250000000.ci.ap-beijing.myqcloud.com
    Content-Length: 166
    Content-Type: application/xml
    <Request>
    <Tag>MediaInfo</Tag>
    <Input>
      <Object>test.mp4</Object>
    </Input>
    <QueueId>p893bcda225bf4945a378da6662e81a89</QueueId>
    </Request>
    

    Response

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Content-Length: 230
    Connection: keep-alive
    Date: Thu, 15 Jun 2017 12:37:29 GMT
    Server: tencent-ci
    x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****
    <Response>
    <JobsDetail>
      <Code>Success</Code>
      <Message>Success</Message>
      <JobId>je8f65004eb8511eaaed4f377124a303c</JobId>
      <State>Submitted</State>
      <CreationTime>2019-07-07T12:12:12+0800</CreationTime>
      <StartTime></StartTime>
      <EndTime></EndTime>
      <QueueId>p893bcda225bf4945a378da6662e81a89</QueueId>
      <Tag>MediaInfo</Tag>
      <Input>
        <Object>test.mp4</Object>
      </Input>
    </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