tencent cloud

文档反馈

提交转封装任务

最后更新时间:2022-07-27 15:17:14

    功能描述

    CreateMediaJobs 用于提交一个任务。

    请求

    请求示例

    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>
    
    说明:

    • Authorization: Auth String(详情请参见 请求签名 文档)。
    • 通过子账号使用时,需要授予相关的权限,详情请参见授权粒度详情文档。

    请求头

    此接口仅使用公共请求头部,详情请参见 公共请求头部 文档。

    请求体

    该请求操作的实现需要有如下请求体。

    <Request>
    <Tag>Segment</Tag>
    <Input>
      <Object></Object>
    </Input>
    <Operation>
      <Segment>
        <Format>mp4</Format>
        <Duration>5</Duration>
      </Segment>
      <Output>
        <Region></Region>
        <Bucket></Bucket>
        <Object></Object>
      </Output>
    </Operation>
    <QueueId></QueueId>
    <CallBack></CallBack>
    </Request>
    

    具体的数据描述如下:

    节点名称(关键字) 父节点 描述 类型 是否必选
    Request 保存请求的容器 Container

    Container 类型 Request 的具体数据描述如下:

    节点名称(关键字) 父节点 描述 类型 是否必选
    Tag Request 创建任务的 Tag:Segment String
    Input Request 待操作的媒体信息 Container
    Operation Request 操作规则 Container
    QueueId Request 任务所在的队列 ID String
    CallBack Request 回调地址 String

    Container 类型 Input 的具体数据描述如下:

    节点名称(关键字) 父节点 描述 类型 是否必选
    Object Request.Input 媒体文件名 String

    Container 类型 Operation 的具体数据描述如下:

    节点名称(关键字) 父节点 描述 类型 是否必选
    Segment Request.Operation 指定转封装参数 Container
    Output Request.Operation 结果输出地址 Container

    Container 类型 Segment 的具体数据描述如下:

    节点名称(关键字) 父节点 描述 类型 是否必选 限制
    Format Request.Operation.Segment 封装格式 String aac、mp3、flac、mp4、ts、mkv、avi、hls、m3u8
    Duration Request.Operation.Segment 转封装时长,单位:秒 String 不小于5的整数
    HlsEncrypt Request.Operation.Segment hls 加密配置 Container

    Container 类型 HlsEncrypt 的具体数据描述如下:

    节点名称(关键字) 父节点 描述 类型 必选 默认值 限制
    IsHlsEncrypt Request.Operation.Segment.HlsEncrypt 是否开启 HLS 加密 String false 1. true/false
    2. Segment.Format 为 HLS 时支持加密
    UriKey Request.Operation.Segment.HlsEncrypt HLS 加密的 key String 当 IsHlsEncrypt 为 true 时,该参数才有意义

    Container 类型 Output 的具体数据描述如下:

    节点名称(关键字) 父节点 描述 类型 是否必选
    Region Request.Operation.Output 存储桶的地域 String
    Bucket Request.Operation.Output 存储结果的存储桶 String
    Object Request.Operation.Output 输出结果的文件名,如果设置了Duration, 且 Format 不为 HLS 或 m3u8 时, 文件名必须包含${Number}参数作为自定义转封装后每一小段音/视频流的输出序号 String

    响应

    响应头

    此接口仅返回公共响应头部,详情请参见 公共响应头部 文档。

    响应体

    该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:

    <Response>
    <JobsDetail>
      <Code></Code>
      <Message></Message>
      <JobId></JobId>
      <State></State>
      <CreationTime></CreationTime>
      <StartTime></StartTime>
      <EndTime></EndTime>
      <QueueId></QueueId>
      <Tag>Segment</Tag>
      <Input>
        <Object></Object>
      </Input>
      <Operation>
        <Segment>
          <Format>mp4</Format>
          <Duration>5</Duration>
          <HlsEncrypt>
            <IsHlsEncrypt>false</IsHlsEncrypt>
            <UriKey></UriKey>
          </HlsEncrypt>
        </Segment>
        <Output>
          <Region></Region>
          <Bucket></Bucket>
          <Object></Object>
        </Output>
        <MediaInfo>
        </MeidaInfo>
      </Operation>
    </JobsDetail>
    </Response>
    

    具体的数据内容如下:

    节点名称(关键字) 父节点 描述 类型
    Response 保存结果的容器 Container

    Container 节点 Response 的内容:

    节点名称(关键字) 父节点 描述 类型
    JobsDetail Response 任务的详细信息 Container

    Container 节点 JobsDetail 的内容:

    节点名称(关键字) 父节点 描述 类型
    Code Response.JobsDetail 错误码,只有 State 为 Failed 时有意义 String
    Message Response.JobsDetail 错误描述,只有 State 为 Failed 时有意义 String
    JobId Response.JobsDetail 新创建任务的 ID String
    Tag Response.JobsDetail 新创建任务的 Tag:Segment String
    State Response.JobsDetail 任务的状态,为 Submitted、Running、Success、Failed、Pause、Cancel 其中一个 String
    CreationTime Response.JobsDetail 任务的创建时间 String
    StartTime Response.JobsDetail 任务的开始时间 String
    EndTime Response.JobsDetail 任务的结束时间 String
    QueueId Response.JobsDetail 任务所属的队列 ID String
    Input Response.JobsDetail 该任务的输入资源地址 Container
    Operation Response.JobsDetail 该任务的规则 Container

    Container 节点 Input 的内容:
    同请求中的 Request.Input 节点。

    Container 节点 Operation 的内容:

    节点名称(关键字) 父节点 描述 类型
    Segment Response.JobsDetail.Operation 同请求中的 Request.Operation.Segment Container
    Output Response.JobsDetail.Operation 文件的输出地址 Container
    MediaInfo Response.JobsDetail.Operation 转码输出视频的信息,没有时不返回 Container

    Container 节点 Output 的内容:
    同请求中的 Request.Operation.Output 节点。

    Container 节点 MediaInfo 的内容:
    同 GenerateMediaInfo 接口中的 Response.MediaInfo 节点。

    错误码

    该请求操作无特殊错误信息,常见的错误信息请参见 错误码 文档。

    实际案例

    请求1

    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>Segment</Tag>
    <Input>
      <Object>test.mp4</Object>
    </Input>
    <Operation>
      <Segment>
        <Format>mp4</Format>
        <Duration>5</Duration>
      </Segment>
      <Output>
        <Region>ap-beijing</Region>
        <Bucket>examplebucket-1250000000</Bucket>
        <Object>test-trans${Number}</Object>
      </Output>
    </Operation>
    <QueueId>p893bcda225bf4945a378da6662e81a89</QueueId>
    </Request>
    

    响应1

    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>Segment</Tag>
      <Input>
        <Object>test.mp4</Object>
      </Input>
      <Operation>
        <Segment>
          <Format>mp4</Format>
          <Duration>5</Duration>
        </Segment>
        <Output>
          <Region>ap-beijing</Region>
          <Bucket>examplebucket-1250000000</Bucket>
          <Object>test-trans${Number}</Object>
        </Output>
      </Operation>
    </JobsDetail>
    </Response>
    

    请求2

    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>Segment</Tag>
    <Input>
      <Object>test.mp4</Object>
    </Input>
    <Operation>
      <Segment>
        <Format>hls</Format>
        <Duration>5</Duration>
        <HlsEncrypt>
          <IsHlsEncrypt>true</IsHlsEncrypt>
          <UriKey>https://example.com/aes.key</UriKey>
        </HlsEncrypt>
      </Segment>
      <Output>
        <Region>ap-beijing</Region>
        <Bucket>examplebucket-1250000000</Bucket>
        <Object>test-trans</Object>
      </Output>
    </Operation>
    <QueueId>p893bcda225bf4945a378da6662e81a89</QueueId>
    </Request>
    

    响应2

    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>Segment</Tag>
      <Input>
        <Object>test.mp4</Object>
      </Input>
      <Operation>
        <Segment>
          <Format>hls</Format>
          <Duration>5</Duration>
          <HlsEncrypt>
            <IsHlsEncrypt>true</IsHlsEncrypt>
            <UriKey>https://example.com/aes.key</UriKey>
          </HlsEncrypt>
        </Segment>
        <Output>
          <Region>ap-beijing</Region>
          <Bucket>examplebucket-1250000000</Bucket>
          <Object>test-trans</Object>
        </Output>
      </Operation>
    </JobsDetail>
    </Response>
    
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持