# 查询联邦学习作业列表 - listFlJob_tenant
#### 功能介绍
查询联邦学习作业列表
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-tics/tics_05_0025.html)。
#### URI
GET /v1/{project_id}/leagues/{league_id}/fl-jobs
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述   |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目ID |
| league_id  | 是    | String | 空间ID |
   
表2Query参数 
| 参数     | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|:---|:---|:---|:---|
| offset | 是    | Integer | 起始位置。最小值0，最大值2的32次方-1                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| limit  | 是    | Integer | 查询个数。最小值0，最大值100                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| filter | 否    | String  | ''''''''''''''''''''''''''''''''过滤条件，最大值128 { "startTime": "", "endTime": "", "jobName": "", "creatorName": "", "desc": false, "status": \[ "NEW", "ACCEPTED", "RUNNING", "SUCCEEDED", "FAILED", "TERMINATED", "PENDING" \], "job_instance_type": \[ "SQL", "HFL", "VFL_TRAIN", "VFL_EVALUATE", "VFL_ID_TRUNCATION", "VFL_FEATURE_SELECTION", "VFL_SAMPLE_ALIGNMENT", "VFL_PREDICT" \], "agentId": "", "orderBy": "", "algorithmType": \[ "XG_BOOST", "LIGHT_BGM", "LOGISTIC_REGRESSION", "NEURAL_NETWORK" \], "jobInstanceId": "" }'''''''''''''''''''''''''''''''' |
   
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | 用户Token。 通过调用接口获取用户Token接口获取。 |
| X-Language   | 是    | String | 根据自己偏好的语言来获取不同语言的返回内容，zh-cn或者en_us                                |
| Content-Type | 是    | String | 发送的实体的MIME类型。推荐用户默认使用application/json，有其他取值时会在具体接口中专门说明。          |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数    | 参数类型                                                                    | 描述                         |
|:---|:---|:---|
| total | Long                                                                    | 总个数，最小值0，最大值Long.MAX_VALUE |
| lists | Array of [FlJobListVo] objects | 作业列表，最大值100                |
   
 表5FlJobListVo 
| 参数                 | 参数类型    | 描述                                                                                                                                                                                                                                                                       |
|:---|:---|:---|
| description        | String  | 作业描述，最大值512                                                                                                                                                                                                                                                              |
| job_id             | String  | 作业id，最大长度32                                                                                                                                                                                                                                                              |
| job_name           | String  | 作业名称，最大长度128                                                                                                                                                                                                                                                             |
| job_type           | String  | 作业类型。作业类型:SQL.联合SQL分析,HFL.横向联邦学习,VFL.纵向联邦学习,PREDICT.预测                                                                                                                                                                                                                   |
| creatorName        | String  | 创建人名称，最大值128                                                                                                                                                                                                                                                             |
| create_time        | String  | 创建时间。                                                                                                                                                                                                                                                                    |
| hfl_type           | String  | fl作业类型枚举。1.TRAIN训练,2.EVALUATE评估                                                                                                                                                                                                                                          |
| hfl_platform_type  | String  | 联邦学习运行平台枚举值。LOCAL（本地），MODEL_ARTS（modelarts）                                                                                                                                                                                                                              |
| learning_rate      | String  | 纵向联邦算法学习率                                                                                                                                                                                                                                                                |
| algorithm_type     | String  | 纵向联邦算法类型枚举。 XG_BOOST, LightGBM LOGISTIC_REGRESSION 逻辑回归 NEURAL_NETWORK 神经网络 FIBINET, |
| learning_task_type | String  | 纵向联邦任务类型。 CLASSIFICATION(1), REGRESSION(2);                                                                                                                                                      |
| ext                | String  | 参数等额外信息。                                                                                                                                                                                                                                                                 |
| is_single_predict  | Boolean | 单方还是双方预测                                                                                                                                                                                                                                                                 |
   
#### 请求示例
查询联邦学习作业列表
```
get https://x.x.x.x:12345/v1/{project_id}/leagues/{league_id}/fl-jobs?offset=0&filter=10
```
#### 响应示例
**状态码：200**
查询联邦学习作业成功
```
{
  "total" : 1,
  "lists" : [ {
    "description" : null,
    "round" : null,
    "epoch" : null,
    "job_id" : "6a08387b3178443a997202a13d0e3335",
    "job_name" : "test12",
    "job_type" : "VFL",
    "creator_name" : "shenlu",
    "create_time" : "2022-02-17T06:55:31.000+00:00",
    "hfl_type" : "TRAIN",
    "hfl_platform_type" : "LOCAL",
    "algorithm_type" : "LOGISTIC_REGRESSION",
    "learning_rate" : "0.5",
    "learning_task_type" : null,
    "ext" : null,
    "is_single_predict" : null
  } ]
}
```
#### 状态码
| 状态码 | 描述         |
|:---|:---|
| 200 | 查询联邦学习作业成功 |
| 401 | 操作无权限      |
| 500 | 内部服务器错误    |