功能说明
数据万象支持自定义设置回调 URL,在任务完成后,系统向该 URL 发送 HTTP POST 请求,请求体中包含通知内容。您可通过配置的回调地址及时了解任务处理的进展和状态,以便进行其他业务操作。
回调内容
任务完成后,系统会向您设置的回调地址发送回调内容,包含完整节点数据的内容展示如下:
<Response><EventName>TaskFinish</EventName><JobsDetail><Code>Success</Code><CreationTime>2022-06-30T18:42:20+0800</CreationTime><EndTime>2022-06-30T18:42:54+0800</EndTime><Input><BucketId>test-123456789</BucketId><Object>output/digital.mp4</Object><Region>ap-chongqing</Region></Input><JobId>j515a494af86111ecb8546d80f2baf56f</JobId><Message>done</Message><Operation><ExtractDigitalWatermark><Message>123456789ab</Message><Type>Text</Type><Version>V1</Version></ExtractDigitalWatermark><UserData>This is my ExtractDigitalWatermark job.</UserData><JobLevel>0</JobLevel></Operation><QueueId>p2242ab62c7c94486915508540933a2c6</QueueId><StartTime>2022-06-30T18:42:21+0800</StartTime><State>Success</State><Tag>ExtractDigitalWatermark</Tag></JobsDetail></Response>
具体的数据内容如下:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Response | 无 | 保存结果的容器 | Container |
Container 节点 Response 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
EventName | Response | 固定值,为 TaskFinish | String |
JobsDetail | Response | Container 数组 |
如果任务是通过工作流触发的,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-06-30T18:42:20+0800</CreationTime><EndTime>2022-06-30T18:42:54+0800</EndTime><Input><BucketId>test-123456789</BucketId><Object>output/digital.mp4</Object><Region>ap-chongqing</Region></Input><JobId>j515a494af86111ecb8546d80f2baf56f</JobId><Message>done</Message><Operation><ExtractDigitalWatermark><Message>123456789ab</Message><Type>Text</Type><Version>V1</Version></ExtractDigitalWatermark><UserData>This is my ExtractDigitalWatermark job.</UserData><JobLevel>0</JobLevel></Operation><QueueId>p2242ab62c7c94486915508540933a2c6</QueueId><StartTime>2022-06-30T18:42:21+0800</StartTime><State>Success</State><Tag>ExtractDigitalWatermark</Tag></JobsDetail></Response>
案例 2:通过任务接口触发的任务回调, 格式为 JSON
{"EventName": "TaskFinish","JobsDetail": [{"Code": "Success","CreationTime": "2022-06-30T18:42:20+0800","EndTime": "2022-06-30T18:42:54+0800","Input": {"BucketId": "test-123456789","Object": "output/digital.mp4","Region": "ap-chongqing"},"JobId": "j515a494af86111ecb8546d80f2baf56f","Message": "done","Operation": {"ExtractDigitalWatermark": {"Message": "123456789ab","Type": "Text","Version": "V1"},"UserData": "This is my ExtractDigitalWatermark job.","JobLevel": 0},"QueueId": "p2242ab62c7c94486915508540933a2c6","StartTime": "2022-06-30T18:42:21+0800","State": "Success","Tag": "ExtractDigitalWatermark"}]}