文档首页> 网络智能体> 联邦学习部署服务> API参考（FL-Client）> API接口> 查询任务
更新时间：2021-12-17 GMT+08:00
查看PDF
分享

查询任务

功能介绍

业务系统通过心跳获悉有新任务，然后调用查询任务接口，获取任务相关信息。

URI

URI格式

/federated/v1/agent/queryTask
参数说明，如表1所示。
表1 参数说明

参数

是否必选

类型

说明

agentId

Y

String

本次联邦注册唯一标识ID

请求

请求样例

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

响应

  • 成功响应样例
{    
"success": true,   
"taskId": "training_taskId-xxx",
"taskType": "training",
"taskParams": "{"subModelIterateTimes":"20","subModelLearningRate":"0.05","xxx":"xxx"}"
}
  • 失败响应样例
{    
"success": false 
}
参数说明，如表2所示。
表2 参数说明

参数

是否必选

类型

说明

success

Y

boolean

是否查询任务成功。

taskId

N

String

任务Id。

taskType

N

String

任务类型。

取值如下所示：

  • none：无任务
  • training：训练任务
  • evaluation：评估任务
  • stop：强制终止所有任务，需要业务系统强行停止当前所有联邦任务。如果重新执行联邦任务，需要等待服务下发新任务。

taskParams

N

String

对应任务的参数，为json格式。需要业务获取处理任务的参数，比如下发training训练任务时，提供模型训练的超参。
父主题： API接口
分享：

    相关文档

    相关产品

close