心跳

业务系统轮询调用心跳接口，如果业务系统有新任务时，则提示有新的任务。

URI格式

/federated/v1/agent/heartbeat

参数说明，如表1所示。

表1 参数说明
参数	是否必选	类型	说明
agentId	Y	String	本次联邦注册唯一标识Id
taskId	N	String	任务Id
taskStatus	N	String	任务状态。取值如下所示： Accepted：接收 Running：运行中 Finished：完成 Failed：失败

请求样例

post    https://endpoint/federated/v1/agent/heartbeat
{    
"agentId": "agentId-xxx"
}

{    
"success": true,   
"newTask": true
}

{    
"success": false,   
"newTask": false
}

参数说明，如表2所示。

表2 参数说明
参数	是否必选	类型	说明
success	Y	boolean	心跳是否成功
newTask	Y	boolean	是否有新任务。取值为“true”，说明有新任务需要处理。此时，业务系统需要调用queryTask接口，查询新任务相关信息并处理。

父主题： API接口

相关文档