tencent cloud

文档反馈

最后更新时间:2022-08-09 14:33:54

    功能说明

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

    回调内容

    任务完成后,系统会向您设置的回调地址发送回调内容,该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:

    <Response>
      <EventName>TaskFinish</EventName>
      <JobsDetail>
          <Code>Success</Code>
          <CreationTime>2022-06-30T18:47:18+0800</CreationTime>
          <EndTime>2022-06-30T18:47:30+0800</EndTime>
          <Input>
              <BucketId>test-123456789</BucketId>
              <Object>input/demo.mp3</Object>
              <Region>ap-chongqing</Region>
          </Input>
          <JobId>j035aca66f86211ec8a5a87e016101404</JobId>
          <Message>SUCCESS</Message>
          <Operation>
              <Output>
                  <Bucket>test-123456789</Bucket>
                  <Object>output/nr.wav</Object>
                  <Region>ap-chongqing</Region>
              </Output>
              <UserData>This is my NoiseReduction job.</UserData>
          </Operation>
          <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
          <StartTime>2022-06-30T18:47:20+0800</StartTime>
          <State>Success</State>
          <Tag>NoiseReduction</Tag>
      </JobsDetail>
    </Response>
    

    具体的数据内容如下:

    节点名称(关键字) 父节点 描述 类型
    Response 保存结果的容器 Container

    Container 节点 Response 的内容:

    节点名称(关键字) 父节点 描述 类型
    EventName Response 固定值,为 TaskFinish String
    JobsDetail Response 任务的详细信息 Container

    Container 节点 JobsDetail 的内容:同提交音频降噪任务接口中的 Response.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-30T18:47:18+0800</CreationTime>
          <EndTime>2022-06-30T18:47:30+0800</EndTime>
          <Input>
              <BucketId>test-123456789</BucketId>
              <Object>input/demo.mp3</Object>
              <Region>ap-chongqing</Region>
          </Input>
          <JobId>j035aca66f86211ec8a5a87e016101404</JobId>
          <Message>SUCCESS</Message>
          <Operation>
              <Output>
                  <Bucket>test-123456789</Bucket>
                  <Object>output/nr.wav</Object>
                  <Region>ap-chongqing</Region>
              </Output>
              <UserData>This is my NoiseReduction job.</UserData>
          </Operation>
          <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
          <StartTime>2022-06-30T18:47:20+0800</StartTime>
          <State>Success</State>
          <Tag>NoiseReduction</Tag>
      </JobsDetail>
    </Response>
    

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

    {
      "EventName": "TaskFinish",
      "JobsDetail": {
          "Code": "Success",
          "CreationTime": "2022-06-30T18:47:18+0800",
          "EndTime": "2022-06-30T18:47:30+0800",
          "Input": {
              "BucketId": "test-123456789",
              "Object": "input/demo.mp3",
              "Region": "ap-chongqing"
          },
          "JobId": "j035aca66f86211ec8a5a87e016101404",
          "Message": "SUCCESS",
          "Operation": {
              "Output": {
                  "Bucket": "test-123456789",
                  "Object": "output/nr.wav",
                  "Region": "ap-chongqing"
              },
              "UserData": "This is my NoiseReduction job."
          },
          "QueueId": "p2242ab62c7c94486915508540933a2c6",
          "StartTime": "2022-06-30T18:47:20+0800",
          "State": "Success",
          "Tag": "NoiseReduction"
      }
    }
    
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持