文档首页> 网络智能体> 联邦学习部署服务> API参考（FL-Server）> 联邦客户端服务> 注册联邦客户端
更新时间：2021-12-17 GMT+08:00
查看PDF
分享

注册联邦客户端

功能介绍

注册联邦客户端

URI

URI格式

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

参数

是否必选

类型

说明

instanceId

Y

String

联邦实例ID

version

Y

String

联邦实例版本

name

Y

String

Client名称

publicKey

N

String

多方场景下的public key，只有多方场景下需要

请求

请求样例

POST https://{{Federal-Address}}/federated/v1/client
{ 
    "instanceId": "xxxx",
    "version": "0.0.1",
    "name": "clientA"
}

响应

  • 成功响应样例
{
    "agentId": "agentId-xxxxxx",
    "code": "0",
    "msg": "success",
    "ext": null
}
  • 失败响应样例
{
    "success": false,
    "code": "23469334.14010.10001",
    "msg": "you have not right to operator this instance!",
    "ext": null
}
参数说明，如表2所示
表2 参数说明

参数

是否必选

类型

说明

code

N

String

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

msg

N

String

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

ext

N

Map

扩展信息

返回值

请参考通用HTTP请求状态码返回值。

父主题： 联邦客户端服务
分享：

    相关文档

    相关产品

close