tencent cloud

文档反馈

DescribeMediaJobs

最后更新时间:2023-12-30 16:25:42

    功能描述

    DescribeMediaJobs 用于拉取符合条件的任务。
    

    请求

    请求示例

    GET /jobs?size=&states=&queueId=&startCreationTime=&endCreationTime= HTTP/1.1
    Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
    Date: <GMT Date>
    Authorization: <Auth String>
    
    说明
    Authorization: Auth String(详情请参见 请求签名 文档)。
    通过子账号使用时,需要授予相关的权限,详情请参见 授权粒度详情 文档。

    请求参数

    参数的具体内容如下:
    节点名称(关键字)
    父节点
    描述
    类型
    是否必选
    queueId
    拉取该队列 ID 下的任务
    String
    tag
    任务的 Tag
    String
    workflowId
    触发该任务的工作流 ID
    String
    inventoryTriggerJobId
    触发该任务的存量触发任务 ID
    String
    inputObject
    该任务的输入文件名,暂仅支持精确匹配
    String
    orderByTime
    Desc 或者 Asc。默认为 Desc
    String
    nextToken
    请求的上下文,用于翻页。上次返回的值
    String
    size
    拉取的最大任务数。默认为10。最大为100
    Integer
    states
    拉取该状态的任务,以,分割,支持多状态:All、Submitted、Running、Success、Failed、Pause、Cancel。默认为 All
    String
    startCreationTime
    拉取创建时间大于该时间的任务。格式为:%Y-%m-%dT%H:%m:%S%z,示例:2001-01-01T00:00:00+0800
    String
    endCreationTime
    拉取创建时间小于该时间的任务。格式为:%Y-%m-%dT%H:%m:%S%z,示例:2001-01-01T23:59:59+0800
    String
    tag 支持以下几种类型:
    任务类型
    tag
    音视频转码
    Transcode
    视频转动图
    Animation
    视频截图
    Snapshot
    智能封面
    SmartCover
    音视频拼接
    Concat
    人声分离
    VoiceSeparate
    精彩集锦
    VideoMontage
    SDR to HDR
    SDRtoHDR
    视频增强
    VideoProcess
    超级分辨率
    SuperResolution
    音视频转封装
    Segment
    数字水印
    DigitalWatermark
    提取数字水印
    ExtractDigitalWatermark
    视频标签
    VideoTag
    获取媒体信息
    MediaInfo
    音视频流分离
    StreamExtract
    视频质量分析
    QualityEstimate
    语音合成
    Tts
    音频降噪
    NoiseReduction

    请求头

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

    请求体

    该请求无请求体。

    响应

    响应头

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

    响应体

    该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
    <Response>
    <JobsDetail>
    ...
    </JobsDetail>
    <NextToken></NextToken>
    </Response>
    具体的数据内容如下:
    节点名称(关键字)
    父节点
    描述
    类型
    Response
    保存结果的容器
    Container
    Container 节点 Response 的内容:
    节点名称(关键字)
    父节点
    描述
    类型
    JobsDetail
    Response
    任务的详细信息
    Container数组
    NextToken
    Response
    翻页的上下文 Token
    String
    对于不同的任务类型,JobsDetail 的内容不同,请参照以下链接:

    错误码

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

    实际案例

    请求

    GET /jobs?queueId=p2242ab62c7c94486915508540933a2c6&tag=Transcode HTTP/1.1
    Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0**********&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
    

    响应

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Content-Length: 666
    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>Running</State>
    <Progress>30</Progress>
    <CreationTime>2022-06-27T15:23:12+0800</CreationTime>
    <StartTime>2022-06-27T15:23:13+0800</StartTime>
    <EndTime>-</EndTime>
    <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
    <Tag>Transcode</Tag>
    <Input>
    <BucketId>test-123456789</BucketId>
    <Object>input/demo.mp4</Object>
    <Region>ap-chongqing</Region>
    </Input>
    <Operation>
    <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
    <WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe22</WatermarkTemplateId>
    <WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe23</WatermarkTemplateId>
    <WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe24</WatermarkTemplateId>
    <RemoveWatermark>
    <Dx>150</Dx>
    <Dy>150</Dy>
    <Width>75</Width>
    <Height>75</Height>
    </RemoveWatermark>
    <DigitalWatermark>
    <Type>Text</Type>
    <Message>123456789ab</Message>
    <Version>V1</Version>
    <IgnoreError>false</IgnoreError>
    <State>Running</State>
    </DigitalWatermark>
    <Output>
    <Region>ap-chongqing</Region>
    <Bucket>test-123456789</Bucket>
    <Object>output/out.mp4</Object>
    </Output>
    <UserData>This is my data.</UserData>
    <JobLevel>0</JobLevel>
    </Operation>
    </JobsDetail>
    <JobsDetail>
    <Code>Success</Code>
    </Message>
    <JobId>j9c0a4726f6ac11ec96aaa9b64ab18d00</JobId>
    <State>Success</State>
    <Progress>100</Progress>
    <CreationTime>2022-06-27T15:23:12+0800</CreationTime>
    <StartTime>2022-06-27T15:23:13+0800</StartTime>
    <EndTime>2022-06-27T15:24:33+0800</EndTime>
    <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
    <Tag>Transcode</Tag>
    <Input>
    <BucketId>test-123456789</BucketId>
    <Object>input/demo.mp4</Object>
    <Region>ap-chongqing</Region>
    </Input>
    <Operation>
    <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
    <WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe22</WatermarkTemplateId>
    <WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe23</WatermarkTemplateId>
    <WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe24</WatermarkTemplateId>
    <RemoveWatermark>
    <Dx>150</Dx>
    <Dy>150</Dy>
    <Width>75</Width>
    <Height>75</Height>
    </RemoveWatermark>
    <DigitalWatermark>
    <Type>Text</Type>
    <Message>123456789ab</Message>
    <Version>V1</Version>
    <IgnoreError>false</IgnoreError>
    <State>Running</State>
    </DigitalWatermark>
    <Output>
    <Region>ap-chongqing</Region>
    <Bucket>test-123456789</Bucket>
    <Object>output/out.mp4</Object>
    </Output>
    <UserData>This is my data.</UserData>
    <JobLevel>0</JobLevel>
    <MediaInfo>
    <Format>
    <Bitrate>834.736000</Bitrate>
    <Duration>13.654000</Duration>
    <FormatLongName>QuickTime / MOV</FormatLongName>
    <FormatName>mov,mp4,m4a,3gp,3g2,mj2</FormatName>
    <NumProgram>0</NumProgram>
    <NumStream>2</NumStream>
    <Size>1424687</Size>
    <StartTime>0.000000</StartTime>
    </Format>
    <Stream>
    <Audio>
    <Bitrate>104.047000</Bitrate>
    <Channel>2</Channel>
    <ChannelLayout>stereo</ChannelLayout>
    <CodecLongName>AAC (Advanced Audio Coding)</CodecLongName>
    <CodecName>aac</CodecName>
    <CodecTag>0x6134706d</CodecTag>
    <CodecTagString>mp4a</CodecTagString>
    <CodecTimeBase>1/44100</CodecTimeBase>
    <Duration>13.653311</Duration>
    <Index>1</Index>
    <Language>und</Language>
    <SampleFmt>fltp</SampleFmt>
    <SampleRate>44100</SampleRate>
    <StartTime>0.000000</StartTime>
    <Timebase>1/44100</Timebase>
    </Audio>
    <Subtitle/>
    <Video>
    <AvgFps>25.000000</AvgFps>
    <Bitrate>763.774000</Bitrate>
    <CodecLongName>H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10</CodecLongName>
    <CodecName>h264</CodecName>
    <CodecTag>0x31637661</CodecTag>
    <CodecTagString>avc1</CodecTagString>
    <CodecTimeBase>1/12800</CodecTimeBase>
    <ColorPrimaries>bt470bg</ColorPrimaries>
    <ColorRange>tv</ColorRange>
    <ColorTransfer>smpte170m</ColorTransfer>
    <Duration>12.960000</Duration>
    <Fps>25.000000</Fps>
    <HasBFrame>0</HasBFrame>
    <Height>960</Height>
    <Index>0</Index>
    <Language>und</Language>
    <Level>10</Level>
    <NumFrames>324</NumFrames>
    <PixFormat>yuv420p</PixFormat>
    <Profile>High</Profile>
    <RefFrames>1</RefFrames>
    <Rotation>0.000000</Rotation>
    <StartTime>0.000000</StartTime>
    <Timebase>1/12800</Timebase>
    <Width>544</Width>
    </Video>
    </Stream>
    </MediaInfo>
    <MediaResult>
    <OutputFile>
    <Bucket>test-123456789</Bucket>
    <Region>ap-chongqing</Region>
    <ObjectName>output/out.mp4</ObjectName>
    <Md5Info>
    <Md5>3df1f845d2ffd20a525a93ec40014d90</Md5>
    <ObjectName>output/out.mp4</ObjectName>
    </Md5Info>
    </OutputFile>
    </MediaResult>
    </Operation>
    </JobsDetail>
    <NextToken>225508</NextToken>
    </Response>