tencent cloud

文档反馈

智能封面

最后更新时间:2024-01-20 16:30:33

    功能说明

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

    回调内容

    任务完成后,系统会向您设置的回调地址发送回调内容,该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
    <Response>
    <EventName>TaskFinish</EventName>
    <JobsDetail>
    <Code>Success</Code>
    <CreationTime>2022-06-30T15:29:42+0800</CreationTime>
    <EndTime>2022-06-30T15:29:48+0800</EndTime>
    <Input>
    <BucketId>test-123456789</BucketId>
    <Object>input/demo.mp4</Object>
    <Region>ap-chongqing</Region>
    </Input>
    <JobId>j6842765cf84611ecb8546d80f2baf56f</JobId>
    <Message/>
    <Operation>
    <MediaInfo>
    <Format/>
    <Stream>
    <Audio/>
    <Subtitle/>
    <Video/>
    </Stream>
    </MediaInfo>
    <MediaResult>
    <OutputFile>
    <Bucket>test-123456789</Bucket>
    <Md5Info/>
    <ObjectName>output/smartcover-0.jpg</ObjectName>
    <ObjectName>output/smartcover-1.jpg</ObjectName>
    <ObjectName>output/smartcover-2.jpg</ObjectName>
    <ObjectName>output/smartcover-3.jpg</ObjectName>
    <ObjectName>output/smartcover-4.jpg</ObjectName>
    <ObjectPrefix/>
    <Region>ap-chongqing</Region>
    </OutputFile>
    </MediaResult>
    <Output>
    <Bucket>test-123456789</Bucket>
    <Object>output/smartcover-${Number}.jpg</Object>
    <Region>ap-chongqing</Region>
    </Output>
    <SmartCover>
    <Count>5</Count>
    <DeleteDuplicates>false</DeleteDuplicates>
    <Format>jpg</Format>
    <Height>960</Height>
    <Width>1280</Width>
    </SmartCover>
    <UserData>This is my SmartCover job.</UserData>
    </Operation>
    <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
    <StartTime>2022-06-30T15:29:43+0800</StartTime>
    <State>Success</State>
    <Tag>SmartCover</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-06-30T15:29:42+0800</CreationTime>
    <EndTime>2022-06-30T15:29:48+0800</EndTime>
    <Input>
    <BucketId>test-123456789</BucketId>
    <Object>input/demo.mp4</Object>
    <Region>ap-chongqing</Region>
    </Input>
    <JobId>j6842765cf84611ecb8546d80f2baf56f</JobId>
    <Message/>
    <Operation>
    <MediaInfo>
    <Format/>
    <Stream>
    <Audio/>
    <Subtitle/>
    <Video/>
    </Stream>
    </MediaInfo>
    <MediaResult>
    <OutputFile>
    <Bucket>test-123456789</Bucket>
    <Md5Info/>
    <ObjectName>output/smartcover-0.jpg</ObjectName>
    <ObjectName>output/smartcover-1.jpg</ObjectName>
    <ObjectName>output/smartcover-2.jpg</ObjectName>
    <ObjectName>output/smartcover-3.jpg</ObjectName>
    <ObjectName>output/smartcover-4.jpg</ObjectName>
    <ObjectPrefix/>
    <Region>ap-chongqing</Region>
    </OutputFile>
    </MediaResult>
    <Output>
    <Bucket>test-123456789</Bucket>
    <Object>output/smartcover-${Number}.jpg</Object>
    <Region>ap-chongqing</Region>
    </Output>
    <SmartCover>
    <Count>5</Count>
    <DeleteDuplicates>false</DeleteDuplicates>
    <Format>jpg</Format>
    <Height>960</Height>
    <Width>1280</Width>
    </SmartCover>
    <UserData>This is my SmartCover job.</UserData>
    </Operation>
    <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
    <StartTime>2022-06-30T15:29:43+0800</StartTime>
    <State>Success</State>
    <Tag>SmartCover</Tag>
    </JobsDetail>
    </Response>

    案例 2:通过工作流触发的任务回调

    <Response>
    <EventName>TaskFinish</EventName>
    <JobsDetail>
    <Code>Success</Code>
    <CreationTime>2022-06-30T15:29:42+0800</CreationTime>
    <EndTime>2022-06-30T15:29:48+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>j6842765cf84611ecb8546d80f2baf56f</JobId>
    <Message/>
    <Operation>
    <MediaInfo>
    <Format/>
    <Stream>
    <Audio/>
    <Subtitle/>
    <Video/>
    </Stream>
    </MediaInfo>
    <MediaResult>
    <OutputFile>
    <Bucket>test-123456789</Bucket>
    <Md5Info/>
    <ObjectName>output/smartcover-0.jpg</ObjectName>
    <ObjectName>output/smartcover-1.jpg</ObjectName>
    <ObjectName>output/smartcover-2.jpg</ObjectName>
    <ObjectName>output/smartcover-3.jpg</ObjectName>
    <ObjectName>output/smartcover-4.jpg</ObjectName>
    <ObjectPrefix/>
    <Region>ap-chongqing</Region>
    </OutputFile>
    </MediaResult>
    <Output>
    <Bucket>test-123456789</Bucket>
    <Object>output/smartcover-${Number}.jpg</Object>
    <Region>ap-chongqing</Region>
    </Output>
    <SmartCover>
    <Count>5</Count>
    <DeleteDuplicates>false</DeleteDuplicates>
    <Format>jpg</Format>
    <Height>960</Height>
    <Width>1280</Width>
    </SmartCover>
    <UserData>This is my SmartCover job.</UserData>
    </Operation>
    <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
    <StartTime>2022-06-30T15:29:43+0800</StartTime>
    <State>Success</State>
    <Tag>SmartCover</Tag>
    <Workflow>
    <Name>SmartCover_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-30T15:29:42+0800",
    "EndTime": "2022-06-30T15:29:48+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": "j6842765cf84611ecb8546d80f2baf56f",
    "Operation": {
    "MediaInfo": {
    "Stream": {
    
    }
    },
    "MediaResult": {
    "OutputFile": {
    "Bucket": "test-123456789",
    "ObjectName": [
    "output/smartcover-0.jpg",
    "output/smartcover-1.jpg",
    "output/smartcover-2.jpg",
    "output/smartcover-3.jpg",
    "output/smartcover-4.jpg"
    ],
    "Region": "ap-chongqing"
    }
    },
    "Output": {
    "Bucket": "test-123456789",
    "Object": "output/smartcover-${Number}.jpg",
    "Region": "ap-chongqing"
    },
    "SmartCover": {
    "Count": "5",
    "DeleteDuplicates": "false",
    "Format": "jpg",
    "Height": "960",
    "Width": "1280"
    },
    "UserData": "This is my SmartCover job."
    },
    "QueueId": "p2242ab62c7c94486915508540933a2c6",
    "StartTime": "2022-06-30T15:29:43+0800",
    "State": "Success",
    "Tag": "SmartCover",
    "Workflow": {
    "Name": "SmartCover_1581665960537",
    "RunId": "ic90edd59f84f11ec9d4f525400a3c59f",
    "WorkflowId": "web6ac56c1ef54dbfa44d7f4103203be9",
    "WorkflowName": "workflow-test"
    }
    }]
    }