功能说明
数据万象支持自定义设置回调 URL,在任务完成后,系统向该 URL 发送 HTTP POST 请求,请求体中包含通知内容。您可通过配置的回调地址及时了解任务处理的进展和状态,以便进行其他业务操作。
回调内容
任务完成后,系统会向您设置的回调地址发送回调内容,包含完整节点数据的内容展示如下:
<Response><EventName>TaskFinish</EventName><JobsDetail><Code>Success</Code><CreationTime>2022-06-30T19:25:11+0800</CreationTime><EndTime>2022-06-30T19:25:14+0800</EndTime><Input><BucketId>test-123456789</BucketId><Object>input/demo.mp4</Object><Region>ap-chongqing</Region></Input><JobId>j4e431ba0f86711ecb8546d80f2baf56f</JobId><Message/><Operation><MediaInfo><Format/><Stream><Audio/><Subtitle/><Video/></Stream></MediaInfo><MediaResult><OutputFile><Bucket>test-123456789</Bucket><Md5Info/><ObjectName>0.jpg</ObjectName><ObjectName>1.jpg</ObjectName><ObjectName>2.jpg</ObjectName><ObjectName>3.jpg</ObjectName><ObjectName>4.jpg</ObjectName><ObjectName>5.jpg</ObjectName><ObjectPrefix>output/snapshot-</ObjectPrefix><Region>ap-chongqing</Region><SpriteOutputFile><Bucket>test-123456789</Bucket><Md5Info/><ObjectName>0.jpg</ObjectName><ObjectPrefix>output/sprite-</ObjectPrefix><Region>ap-chongqing</Region></SpriteOutputFile></OutputFile></MediaResult><Output><Bucket>test-123456789</Bucket><Object>output/snapshot-${number}.jpg</Object><Region>ap-chongqing</Region><SpriteObject>output/sprite-${number}.jpg</SpriteObject></Output><TemplateId>t1f16e1dfbdc9ds4105b31632d45710642a</TemplateId><TemplateName>template_snapshot</TemplateName><UserData>This is my Snapshot job.</UserData><JobLevel>0</JobLevel></Operation><QueueId>p2242ab62c7c94486915508540933a2c6</QueueId><StartTime>2022-06-30T19:25:12+0800</StartTime><State>Success</State><Tag>Snapshot</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-30T19:25:11+0800</CreationTime><EndTime>2022-06-30T19:25:14+0800</EndTime><Input><BucketId>test-123456789</BucketId><Object>input/demo.mp4</Object><Region>ap-chongqing</Region></Input><JobId>j4e431ba0f86711ecb8546d80f2baf56f</JobId><Message/><Operation><MediaInfo><Format/><Stream><Audio/><Subtitle/><Video/></Stream></MediaInfo><MediaResult><OutputFile><Bucket>test-123456789</Bucket><Md5Info/><ObjectName>0.jpg</ObjectName><ObjectName>1.jpg</ObjectName><ObjectName>2.jpg</ObjectName><ObjectName>3.jpg</ObjectName><ObjectName>4.jpg</ObjectName><ObjectName>5.jpg</ObjectName><ObjectPrefix>output/snapshot-</ObjectPrefix><Region>ap-chongqing</Region><SpriteOutputFile><Bucket>test-123456789</Bucket><Md5Info/><ObjectName>0.jpg</ObjectName><ObjectPrefix>output/sprite-</ObjectPrefix><Region>ap-chongqing</Region></SpriteOutputFile></OutputFile></MediaResult><Output><Bucket>test-123456789</Bucket><Object>output/snapshot-${number}.jpg</Object><Region>ap-chongqing</Region><SpriteObject>output/sprite-${number}.jpg</SpriteObject></Output><TemplateId>t1f16e1dfbdc9ds4105b31632d45710642a</TemplateId><TemplateName>template_snapshot</TemplateName><UserData>This is my Snapshot job.</UserData><JobLevel>0</JobLevel></Operation><QueueId>p2242ab62c7c94486915508540933a2c6</QueueId><StartTime>2022-06-30T19:25:12+0800</StartTime><State>Success</State><Tag>Snapshot</Tag></JobsDetail></Response>
案例 2:通过工作流触发的任务回调
<Response><EventName>TaskFinish</EventName><JobsDetail><Code>Success</Code><CreationTime>2022-06-30T19:25:11+0800</CreationTime><EndTime>2022-06-30T19:25:14+0800</EndTime><Input><BucketId>test-123456789</BucketId><Object>input/demo.mp4</Object><Region>ap-chongqing</Region><CosHeaders><Key>Content-Type</Key><Value>video/mp4</Value></CosHeaders><CosHeaders><Key>x-cos-request-id</Key><Value>NjJiZDYwYTFfNjUzYTYyNjRfZjEwZl8xMmZhYzY5</Value></CosHeaders><CosHeaders><Key>EventName</Key><Value>cos:ObjectCreated:Put</Value></CosHeaders><CosHeaders><Key>Size</Key><Value>1424687</Value></CosHeaders></Input><JobId>j4e431ba0f86711ecb8546d80f2baf56f</JobId><Message/><Operation><MediaInfo><Format/><Stream><Audio/><Subtitle/><Video/></Stream></MediaInfo><MediaResult><OutputFile><Bucket>test-123456789</Bucket><Md5Info/><ObjectName>0.jpg</ObjectName><ObjectName>1.jpg</ObjectName><ObjectName>2.jpg</ObjectName><ObjectName>3.jpg</ObjectName><ObjectName>4.jpg</ObjectName><ObjectName>5.jpg</ObjectName><ObjectPrefix>output/snapshot-</ObjectPrefix><Region>ap-chongqing</Region><SpriteOutputFile><Bucket>test-123456789</Bucket><Md5Info/><ObjectName>0.jpg</ObjectName><ObjectPrefix>output/sprite-</ObjectPrefix><Region>ap-chongqing</Region></SpriteOutputFile></OutputFile></MediaResult><Output><Bucket>test-123456789</Bucket><Object>output/snapshot-${number}.jpg</Object><Region>ap-chongqing</Region><SpriteObject>output/sprite-${number}.jpg</SpriteObject></Output><TemplateId>t1f16e1dfbdc9ds4105b31632d45710642a</TemplateId><TemplateName>template_snapshot</TemplateName><UserData>This is my Snapshot job.</UserData><JobLevel>0</JobLevel></Operation><QueueId>p2242ab62c7c94486915508540933a2c6</QueueId><StartTime>2022-06-30T19:25:12+0800</StartTime><State>Success</State><Tag>Snapshot</Tag><Workflow><Name>Snapshot_1581665960537</Name><RunId>ic90edd59f84f11ec9d4f525400a3c59f</RunId><WorkflowId>web6ac56c1ef54dbfa44d7f4103203be9</WorkflowId><WorkflowName>workflow-test</WorkflowName></Workflow></JobsDetail></Response>
案例 3:通过工作流触发的任务回调, 格式为 JSON
{"EventName": "TaskFinish","JobsDetail": [{"Code": "Success","CreationTime": "2022-06-30T19:25:11+0800","EndTime": "2022-06-30T19:25:14+0800","Input": {"BucketId": "test-123456789","Object": "input/demo.mp4","Region": "ap-chongqing","CosHeaders": [{"Key": "Content-Type","Value": "video/mp4"},{"Key": "x-cos-request-id","Value": "NjJiZDYwYTFfNjUzYTYyNjRfZjEwZl8xMmZhYzY5"},{"Key": "EventName","Value": "cos:ObjectCreated:Put"},{"Key": "Size","Value": "1424687"}]},"JobId": "j4e431ba0f86711ecb8546d80f2baf56f","Operation": {"MediaInfo": {"Stream": {}},"MediaResult": {"OutputFile": {"Bucket": "test-123456789","ObjectName": ["0.jpg","1.jpg","2.jpg","3.jpg","4.jpg","5.jpg"],"ObjectPrefix": "output/snapshot-","Region": "ap-chongqing","SpriteOutputFile": {"Bucket": "test-123456789","ObjectName": ["0.jpg"],"ObjectPrefix": "output/sprite-","Region": "ap-chongqing"}}},"Output": {"Bucket": "test-123456789","Object": "output/snapshot-${number}.jpg","Region": "ap-chongqing","SpriteObject": "output/sprite-${number}.jpg"},"TemplateId": "t1f16e1dfbdc9ds4105b31632d45710642a","TemplateName": "template_snapshot","UserData": "This is my Snapshot job.","JobLevel": 0},"QueueId": "p2242ab62c7c94486915508540933a2c6","StartTime": "2022-06-30T19:25:12+0800","State": "Success","Tag": "Snapshot","Workflow": {"Name": "Snapshot_1581665960537","RunId": "ic90edd59f84f11ec9d4f525400a3c59f","WorkflowId": "web6ac56c1ef54dbfa44d7f4103203be9","WorkflowName": "workflow-test"}}]}