# 保存纵向联邦作业 - saveFlVerticalJob
#### 功能介绍
保存纵向联邦作业
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-tics/tics_05_0025.html)。
#### URI
PUT /v1/{project_id}/leagues/{league_id}/fl-vertical-jobs/{job_id}
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                  |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目ID，最大32位，由字母和数字组成 |
| league_id  | 是    | String | 空间ID，最大32位，由字母和数字组成 |
| job_id     | 是    | String | 作业id，最大32位，由字母和数字组成 |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                   |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | 用户Token。由一个或多个字母数字+-=符号组成。 通过调用接口获取用户Token接口获取。 |
| X-Language   | 是    | String | 根据自己偏好的语言来获取不同语言的返回内容，zh-cn或者en_us                                                   |
| Content-Type | 是    | String | 发送的实体的MIME类型。推荐用户默认使用application/json，有其他取值时会在具体接口中专门说明。                             |
   
表3请求Body参数 
| 参数                 | 是否必选 | 参数类型                                                                                      | 描述                                                                                                                                   |
|:---|:---|:---|:---|
| description        | 否    | String                                                                                    | 作业描述，最大长度512                                                                                                                         |
| datasets           | 否    | String                                                                                    | 每个可信计算节点的数据集名                                                                                                                        |
| features           | 否    | Array of [DatasetFeatureEntity] objects | 数据集特征列                                                                                                                               |
| label              | 否    | String                                                                                    | 标签列，最大长度100                                                                                                                          |
| epoch              | 否    | Integer                                                                                   | lr迭代数，最小值1                                                                                                                           |
| job_name           | 是    | String                                                                                    | 作业名称，最大长度128，名称不能以空白字符开头结尾、或者包含下列任何字符：\\ / : \* ? " \< \> \|，长度要求在1\~128之间。                                                          |
| algorithm_type     | 是    | String                                                                                    | 纵向联邦算法类型枚举，XG_BOOST，LIGHT_BGM，LOGISTIC_REGRESSION 逻辑回归，NEURAL_NETWORK 神经网络，FIBINET                                                   |
| work_step          | 否    | String                                                                                    | 纵向联邦操作步骤枚举值。DATA_SELECTION.数据选择,SAMPLE_ALIGNMENT.样本对齐,FEATURE_SELECTION.特征选择,MODEL_TRAIN.模型训练,MODEL_EVALUATION.模型评估,MODEL_PREDICT.预测 |
| learning_rate      | 否    | String                                                                                    | 纵向联邦算法学习率，最大长度16                                                                                                                     |
| label_dataset      | 否    | String                                                                                    | 标签数据集，最大长度100                                                                                                                        |
| label_agent        | 否    | String                                                                                    | 标签方可信计算节点，最大长度100                                                                                                                    |
| batch_size         | 否    | Integer                                                                                   | lr批大小，最小值1                                                                                                                           |
| grad_epsilon       | 否    | String                                                                                    | lr梯度收敛阈值，默认null                                                                                                                      |
| tree_num           | 否    | Integer                                                                                   | xgboost树数量，最大值2的31次方-1                                                                                                               |
| tree_depth         | 否    | Integer                                                                                   | xgboost树深度，最大值2的31次方-1                                                                                                               |
| split_num          | 否    | Integer                                                                                   | xgboost切分点数量，最大值2的31次方-1                                                                                                             |
| current_agent_id   | 否    | String                                                                                    | 发起方agentid                                                                                                                           |
| learning_task_type | 否    | String                                                                                    | 纵向联邦作业类型 CLASSIFICATION(1), REGRESSION(2)                                                                                            |
| predict_threshold  | 否    | String                                                                                    | 纵向联邦算法预测阈值                                                                                                                           |
| is_single_predict  | 否    | Boolean                                                                                   | 单方还是双方预测                                                                                                                             |
   
 表4DatasetFeatureEntity 
| 参数           | 是否必选 | 参数类型             | 描述            |
|:---|:---|:---|:---|
| agent_id     | 是    | String           | 数据集所属agent id |
| dataset_name | 是    | String           | 数据集名称         |
| features     | 是    | Array of strings | 数据集特征集合       |
   
#### 响应参数
**状态码：200**
表5响应Body参数 
| 参数 | 参数类型   | 描述 |
|:---|:---|:---|
| -  | String | -- |
   
#### 请求示例
保存纵向联邦作业
```
put https://x.x.x.x:12345/v1/{project_id}/leagues/{league_id}/fl-vertical-jobs/{job_id}
{
  "datasets" : "018713527a1d49638eb27b305bc0cc8c.breast_hetero_mini_host.space_creator,0573513cac934b6aab79856c355ee7a2.ief_breast_hetero_mini_guest.space_creator",
  "work_step" : "MODEL_TRAIN",
  "job_name" : "ief_xg_fenlei_ief2cce",
  "host_agent_id" : "018713527a1d49638eb27b305bc0cc8c,0573513cac934b6aab79856c355ee7a2",
  "algorithm_type" : "XG_BOOST",
  "learning_task_type" : "CLASSIFICATION",
  "label_dataset" : "ief_breast_hetero_mini_guest",
  "label" : "y",
  "label_agent" : "0573513cac934b6aab79856c355ee7a2",
  "host_agent_name" : "agent_tics,agent_1656",
  "features" : [ {
    "agent_id" : "018713527a1d49638eb27b305bc0cc8c",
    "dataset_name" : "breast_hetero_mini_host",
    "features" : [ "x3", "x4", "x5" ]
  }, {
    "agent_id" : "0573513cac934b6aab79856c355ee7a2",
    "dataset_name" : "ief_breast_hetero_mini_guest",
    "features" : [ "x0", "x1", "x2" ]
  } ]
}
```
#### 响应示例
无
#### 状态码
| 状态码 | 描述         |
|:---|:---|
| 200 | 保存纵向联邦作业成功 |
| 401 | 操作无权限      |
| 500 | 内部服务器错误    |