查询联邦学习作业列表
功能介绍
查询联邦学习作业列表
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/leagues/{league_id}/fl-jobs
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目id，最大32位，字母和数字组成 最小长度：0 最大长度：32 |
league_id |
是 |
String |
空间id，最大32位，字母和数字组成 最小长度：0 最大长度：32 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
limit |
是 |
Integer |
每页记录数，取值0-100 最小值：0 最大值：100 缺省值：10 |
offset |
是 |
Integer |
记录数偏移量 最小值：0 最大值：2147483647 缺省值：0 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户凭证 |
Content-Type |
是 |
String |
消息体的类型（格式） 缺省值：application/json |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
lists |
Array of FlJobListVo objects |
实例集合 |
total |
Long |
总记录数 |
参数 |
参数类型 |
描述 |
|---|---|---|
algorithm_type |
String |
纵向联邦算法类型枚举。XG_BOOSTXGBoost，LIGHT_BGMLightGBM，LOGISTIC_REGRESSION逻辑回归，NEURAL_NETWORK神经网络，FIBINETFIBINET 枚举值：
|
approval_status |
String |
FL作业审批状态。APPROVED审批通过，APPROVING审批中，NEW新建，REJECTED驳回，REVOKED撤销 枚举值：
|
create_time |
String |
创建时间 |
creator_name |
String |
创建人名称 最小长度：0 最大长度：128 |
description |
String |
作业描述 最小长度：0 最大长度：512 |
ext |
String |
参数等额外信息 最小长度：0 最大长度：512 |
hfl_platform_type |
String |
联邦学习运行平台枚举值。LOCAL本地 枚举值：
|
hfl_type |
String |
FL作业类型枚举。TRAIN训练，EVALUATE评估 枚举值：
|
is_single_predict |
Boolean |
单方还是双方预测 |
job_id |
String |
作业id 最小长度：0 最大长度：32 |
job_name |
String |
作业名称 最小长度：0 最大长度：128 |
job_type |
String |
作业类型。SQL联合SQL分析，HFL横向联邦学习，VFL纵向联邦学习，PREDICT预测，DATA_EXCHANGE数据交换 枚举值：
|
learning_task_type |
String |
纵向联邦任务类型。CLASSIFICATION分类，REGRESSION拟合 枚举值：
|
状态码： 401
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码： 500
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
请求示例
查询联邦学习作业列表
get /v1/{project_id}/leagues/{league_id}/fl-jobs?offset=0&limit=10
响应示例
状态码： 200
保存联邦学习作业成功
{
"total" : 2,
"lists" : [ {
"job_id" : "25e5a949eb1c44528b2881448a1db5aa",
"job_name" : "ss",
"job_type" : "VFL",
"creator_name" : "zhangsan",
"create_time" : "2022-10-26T09:04:50.000+00:00",
"hfl_type" : "TRAIN",
"hfl_platform_type" : "LOCAL",
"algorithm_type" : "FIBINET"
}, {
"description" : "cc",
"job_id" : "1aec7ad4ee834e3c9f08adefb7ab2fe8",
"job_name" : "featuretest",
"job_type" : "VFL",
"creator_name" : "zhangsan",
"create_time" : "2022-10-19T06:45:37.000+00:00",
"hfl_type" : "TRAIN",
"hfl_platform_type" : "LOCAL",
"algorithm_type" : "LOGISTIC_REGRESSION"
} ]
}
状态码
状态码 |
描述 |
|---|---|
200 |
保存联邦学习作业成功 |
401 |
操作无权限 |
500 |
内部服务器错误 |
