tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

任务回调内容

最后更新时间：2023-12-30 16:22:28

    功能说明

    数据万象支持自定义设置回调 URL，在任务完成后，系统向该 URL 发送 HTTP POST 请求，请求体中包含通知内容。您可通过配置的回调地址及时了解任务处理的进展和状态，以便进行其他业务操作。

    回调内容

    任务完成后，系统会向您设置的回调地址发送回调内容，该响应体返回为 application/xml 数据，包含完整节点数据的内容展示如下：
    <Response>
           <JobsDetail>
               <Code></Code>
               <Message></Message>
               <JobId></JobId>
               <State></State>
               <CreationTime></CreationTime>
               <EndTime></EndTime>
               <QueueId></QueueId>
               <Tag></Tag>
               <Input>
                     <CosHeaders></CosHeaders>
                     <Region></Region>
                     <BucketId></BucketId>
                     <Object></Object>
               </Input>
               <Operation>
                     <TemplateId></TemplateId>
                     <TemplateName></TemplateName>
                     <MediaResult></MediaResult>
                     <Output>
                        <Region></Region>
                        <Bucket></Bucket>
                        <Object></Object>
                     </Output>
                     <MediaInfo>
                     </MeidaInfo>
               </Operation>
               <Workflow>   
                     <RunId></RunId>   
                     <WorkflowId></WorkflowId>  
                     <WorkflowName></WorkflowName>  
                     <Name></Name>
               </Workflow>
           </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
    String
    State
    Response.JobsDetail
    任务的状态，值为 Success、Failed 其中一个
    String
    CreationTime
    Response.JobsDetail
    任务的创建时间
    String
    EndTime
    Response.JobsDetail
    任务的结束时间
    String
    QueueId
    Response.JobsDetail
    任务所属的队列 ID
    String
    Input
    Response.JobsDetail
    该任务的输入资源地址
    Container
    Operation
    Response.JobsDetail
    该任务的规则
    Container
    Workflow
    Response.JobsDetail
    该任务的所属工作流信息
    Container
    Container 节点 Input 的内容：
    节点名称（关键字）
    父节点
    描述
    类型
    CosHeaders
    Response.JobsDetail.Input
    输入文件的自定义 Header 信息，数组类型，会有多个，只有工作流触发的任务才会包含此内容。
    Container
    Object
    Response.JobsDetail.Input
    输入文件名，在 COS 中称为对象键（ObjectKey）
    String
    Region
    Response.JobsDetail.Input
    输入存储桶地域
    String
    BucketId
    Response.JobsDetail.Input
    输入存储桶 ID
    String
    Container 节点 CosHeaders 的内容：
    节点名称（关键字）
    父节点
    描述
    类型
    Key
    Response.JobsDetail.Input.CosHeaders
    自定义 Header 的名称
    String
    Value
    Response.JobsDetail.Input.CosHeaders
    自定义 Header 的值
    String
    Container 节点 Operation 的内容：
    节点名称（关键字）
    父节点
    描述
    类型
    TemplateId
    Response.JobsDetail.Operation
    任务的模板 ID
    String
    TemplateName
    Response.JobsDetail.Operation
    任务的模板名称
    String
    Output
    Response.JobsDetail.Operation
    设置的文件输出地址
    Container
    MediaResult
    Response.JobsDetail.Operation
    任务的输出信息
    Container
    MediaInfo
    Response.JobsDetail.Operation
    转码输出视频的信息，没有时不返回
    Container
    Container 节点 Output 的内容：
    节点名称（关键字）
    父节点
    描述
    类型
    Region
    Response.Operation.Output
    存储桶的地域
    String
    Bucket
    Response.Operation.Output
    存储结果的存储桶
    String
    Object
    Response.Operation.Output
    结果文件的名称
    String
    Container 节点 MediaResult 的内容：
    节点名称（关键字）
    父节点
    描述
    类型
    OutputFile
    Response.Operation.MediaResult
    实际的输出文件信息
    Container
    Container 节点 OutputFile 的内容：
    节点名称（关键字）
    父节点
    描述
    类型
    Region
    Response.Operation.MediaResult.OutputFile
    存储桶的地域
    String
    Bucket
    Response.Operation.MediaResult.OutputFile
    存储结果的存储桶
    String
    ObjectPrefix
    Response.Operation.MediaResult.OutputFile
    输出文件名前缀
    String
    ObjectName
    Response.Operation.MediaResult.OutputFile
    输出文件名列表，数组类型，可能会有多个
    String
    注意
    实际输出的文件为 Region 地域的 Bucket 下的 StringConcat(ObjectPrefix,ObjectName) 文件。
    Container 节点 Workflow 的内容：
    节点名称（关键字）
    父节点
    描述
    类型
    RunId
    Response.Workflow
    工作流实例 ID
    String
    WorkflowId
    Response.Workflow
    工作流 ID
    String
    WorkflowName
    Response.Workflow
    工作流名称
    String
    Name
    Response.Workflow
    工作流节点名称
    String
    Container 节点 MediaInfo 的内容： 同GenerateMediaInfo 接口中的 Response.MediaInfo 节点。

    实际案例

    <Response>
        <JobsDetail>
            <Code>Success</Code>
            <CreationTime>2020-11-16T16:43:29+0800</CreationTime>
            <EndTime>2020-11-16T16:43:33+0800</EndTime>
            <Input>
                <CosHeaders>
                    <Key>x-cos-meta-test</Key>
                    <Value>testvalue</Value>
                </CosHeaders>
                <CosHeaders>
                    <Key>x-cos-meta-name</Key>
                    <Value>xxxxxx</Value>
                </CosHeaders>
                <CosHeaders>
                    <Key>x-cos-meta-age</Key>
                    <Value>10</Value>
                </CosHeaders>
                <Object>1/2/3/4/5/xxx.mp4</Object>
                <Region>ap-beijing</Region>
                <BucketId>examplebucket-1250000000</BucketId>
            </Input>
            <JobId>jccddc41c27e711ebbff5874bc5b36868</JobId>
            <Message/>
            <Operation>
                <MediaResult>
                    <OutputFile>
                        <Bucket>examplebucket-1250000000</Bucket>
                        <Md5Info>
                            <Md5>39ad161a7807240f4d6f94767e8e2f89</Md5>
                            <ObjectName>1/2/转mp4格式-xxx_iccba81fa27e711eb989d525400276c76.mp4</ObjectName>
                        </Md5Info>
                        <ObjectName>1/2/转mp4格式-xxx_iccba81fa27e711eb989d525400276c76.mp4</ObjectName>
                        <ObjectPrefix/>
                        <Region>ap-chongqing</Region>
                    </OutputFile>
                </MediaResult>
                <Output>
                    <Bucket>examplebucket-1250000000</Bucket>
                    <Object>1/2/转mp4格式-xxx_iccba81fa27e711eb989d525400276c76.${ext}</Object>
                    <Region>ap-chongqing</Region>
                </Output>
                <TemplateId>t182c0ca7d91ca40969a3fc97c5559091a</TemplateId>
                <TemplateName>example</TemplateName>
            </Operation>
            <Workflow>   
                <RunId>rccddc41c27e711ebbff5874bc5b36868</RunId>   
                <WorkflowId>wccddc41c27e711ebbff5874bc5b36868</WorkflowId>  
                <WorkflowName>workflow</WorkflowName>  
                <Name>Transcode_1600413767444</Name>
            </Workflow>
            <QueueId>p791b0bca54ee44289f0d4b1d90796c4f</QueueId>
            <State>Success</State>
            <Tag>Transcode</Tag>
        </JobsDetail>
    </Response>
    
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款