tencent cloud

文档反馈

翻译任务回调

最后更新时间:2024-01-20 16:35:12

    功能说明

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

    回调内容

    任务完成后,系统会向您设置的回调地址发送回调内容,该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
    <Response>
    <EventName>TaskFinish</EventName>
    <JobsDetail>
    <Code>Success</Code>
    <CreationTime>2022-07-25T16:35:39+0800</CreationTime>
    <EndTime>2022-07-25T16:35:43+0800</EndTime>
    <Input>
    <Object>input/en.pdf</Object>
    <Lang>en</Lang>
    <Type>pdf</Type>
    <BasicType>pptx</BasicType>
    </Input>
    <JobId>ac34be3aa0bf411ed9ce39d7cc972e427</JobId>
    <Message>Success</Message>
    <Operation>
    <Output>
    <Region>ap-chongqing</Region>
    <Bucket>test-123456789</Bucket>
    <Object>output/zh.pdf</Object>
    </Output>
    <Translation>
    <Lang>en</Lang>
    <Type>txt</Type>
    </Translation>
    <UserData>This is my Translation job.</UserData>
    <JobLevel>0</JobLevel>
    </Operation>
    <QueueId>pbde29b842b1b4e2ea4f0b20d264fcec2</QueueId>
    <StartTime>2022-07-25T16:35:39+0800</StartTime>
    <State>Success</State>
    <Tag>Translation</Tag>
    </JobsDetail>
    </Response>
    具体的数据内容如下:
    节点名称(关键字)
    父节点
    描述
    类型
    Response
    保存结果的容器
    Container
    Container 节点 Response 的内容:
    节点名称(关键字)
    父节点
    描述
    类型
    EventName
    Response
    固定值,为 TaskFinish
    String
    JobsDetail
    Response
    任务的详细信息
    Container
    Container 节点 JobsDetail 的内容:
    如果任务是通过工作流触发的,Response.JobsDetail.Input 还会包含 CosHeaders 节点,类型为 Container 数组。
    Container 节点 CosHeaders 的内容:
    节点名称(关键字)
    父节点
    描述
    类型
    Key
    Response.JobsDetail.Input.CosHeaders
    自定义 Header 的名称
    String
    Value
    Response.JobsDetail.Input.CosHeaders
    自定义 Header 的值
    String
    如果任务是通过工作流触发的,Response.JobsDetail 还会包含 Workflow 节点,类型为 Container。
    Container 节点 Workflow 的内容:
    节点名称(关键字)
    父节点
    描述
    类型
    RunId
    Response.Workflow
    工作流实例 ID
    String
    WorkflowId
    Response.Workflow
    工作流 ID
    String
    WorkflowName
    Response.Workflow
    工作流名称
    String
    Name
    Response.Workflow
    工作流节点名称
    String

    实际案例

    案例 1:通过任务接口触发的任务回调

    <Response>
    <EventName>TaskFinish</EventName>
    <JobsDetail>
    <Code>Success</Code>
    <CreationTime>2022-07-25T16:35:39+0800</CreationTime>
    <EndTime>2022-07-25T16:35:43+0800</EndTime>
    <Input>
    <Object>input/en.pdf</Object>
    <Lang>en</Lang>
    <Type>pdf</Type>
    <BasicType>pptx</BasicType>
    </Input>
    <JobId>ac34be3aa0bf411ed9ce39d7cc972e427</JobId>
    <Message>Success</Message>
    <Operation>
    <Output>
    <Region>ap-chongqing</Region>
    <Bucket>test-123456789</Bucket>
    <Object>output/zh.pdf</Object>
    </Output>
    <Translation>
    <Lang>en</Lang>
    <Type>txt</Type>
    </Translation>
    <UserData>This is my Translation job.</UserData>
    <JobLevel>0</JobLevel>
    </Operation>
    <QueueId>pbde29b842b1b4e2ea4f0b20d264fcec2</QueueId>
    <StartTime>2022-07-25T16:35:39+0800</StartTime>
    <State>Success</State>
    <Tag>Translation</Tag>
    </JobsDetail>
    </Response>

    案例 2:通过任务触发的任务回调,格式为 JSON

    {
    "EventName": "TaskFinish",
    "JobsDetail": {
    "Code": "Success",
    "CreationTime": "2022-07-25T16:35:39+0800",
    "EndTime": "2022-07-25T16:35:43+0800",
    "Input": {
    "Object": "input/en.pdf",
    "Lang": "en",
    "Type": "pdf",
    "BasicType": "pptx"
    },
    "JobId": "ac34be3aa0bf411ed9ce39d7cc972e427",
    "Message": "Success",
    "Operation": {
    "Output": {
    "Region": "ap-chongqing",
    "Bucket": "test-123456789",
    "Object": "output/zh.pdf"
    },
    "Translation": {
    "Lang": "en",
    "Type": "txt"
    },
    "UserData": "This is my Translation job.",
    "JobLevel": 0,
    },
    "QueueId": "pbde29b842b1b4e2ea4f0b20d264fcec2",
    "StartTime": "2022-07-25T16:35:39+0800",
    "State": "Success",
    "Tag": "Translation"
    }
    }