更新时间:2021-12-17 GMT+08:00
分享

客户端发送心跳信息

功能介绍

客户端发送心跳信息

URI

URI格式

POST https://{{Federal-IP}}/federated/v1/heartbeat
参数说明,如表1所示。
表1 参数说明

参数

是否必选

类型

说明

agentId

Y

String

客户端ID

taskId

N

String

任务ID。服务端生成的ID,再带回到服务端

clientStatus

Y

String

客户端状态。

目前支持的状态,如下所示:

  • OFFLINE:离线状态
  • TO_BE_APPROVED:待审批状态
  • INIT:初始状态
  • ABNORMAL:异常状态
  • IDLE:空闲,表示可以启动联邦
  • MODEL_DOWNLOADING:下载模型
  • MODEL_DOWNLOADED:完成下载模型
  • MODEL_DOWNLOAD_FAILED:模型下载失败
  • MODEL_TRAINING:本地训练
  • MODEL_TRAINED: 完成本地训练
  • MODEL_TRAIN_FAILED:训练失败
  • MODEL_UPLOADING:上传模型
  • MODEL_UPLOADED:完成上传模型
  • MODEL_UPLOAD_FAILED:模型上传失败
  • MODEL_TESTING:测试模型
  • MODEL_TESTED:完成测试模型
  • MODEL_TEST_FAILED:测试失败
  • MODEL_KPI_UPLOADING:上传模型KPI
  • MODEL_KPI_UPLOADED:完成上传模型KPI
  • MODEL_KPI_UPLOAD_FAILED:上传模型KPI失败

请求

请求样例

POST https://{{Federal-IP}}/federated/v1/heartbeat
{ 
    "agentId": "xxxx",
    "taskId ": "zzzz",
    "clientStatus": "MODEL_TRAINING"
}

响应

  • 成功响应样例
{
    "success": true,
     "code": "0",
     "msg": "success",    
     "serverStatus": "READY",
     "task": {
         "taskId": "xxx",    
         "type": "STOP"
        }
}          
  • 失败响应样例
{
    "success": false,
    "code": "23469334.14010.10001",
    "msg": "you have not right to operator this instance!"
} 
参数说明,如表2所示。
表2 参数说明

参数

是否必选

类型

说明

code

N

String

状态码。成功为0,失败情况下为非0

msg

N

String

返回的message信息。失败情况下为错误信息

success

N

Boolean

是否成功

serverStatus

N

String

服务端状态

task

N

Task

任务

Task对象的参数说明,如表3所示。

表3 参数说明

参数

是否必选

类型

说明

taskId

N

String

任务ID,客户端上报消息时需要带过来

type

N

String

任务类型。

目前支持的任务类型,如下所示:

  • NONE:无任务
  • INIT:初始化
  • MODEL_DOWNLOAD: 模型下载
  • MODEL_TRAIN:模型训练
  • MODEL_UPLOAD:模型上传
  • MODEL_TEST:测试模型
  • KPI_UPLOAD:指标上传
  • STOP:训练停止
分享:

    相关文档

    相关产品

close