文档首页/ 可信智能计算服务 TICS/ API参考/ 计算节点API/ 联邦学习作业管理/ 执行样本对齐
更新时间：2024-11-21 GMT+08:00
查看PDF
分享

执行样本对齐

功能介绍

执行样本对齐

调用方法

请参见如何调用API。

URI

POST /v1/{project_id}/leagues/{league_id}/fl-vertical-jobs/{job_id}/sampleAlignment

表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类型
表3 请求Body参数

参数

是否必选

参数类型

描述

instance_id

否

String

实例id，最大32位，由字母和数字组成

job_instance_type

否

String

纵向联邦作业类型。

SQL,

HFL,

VFL_TRAIN,

VFL_EVALUATE,

VFL_ID_TRUNCATION,

VFL_FEATURE_SELECTION,

VFL_SAMPLE_ALIGNMENT,

VFL_PREDICT,

PIR_SQL;

job_name

否

String

作业名称。名称不能以空白字符开头结尾、或者包含下列任何字符：\ / : * ? " < > |，长度要求在1~128之间

，最大值2的31次方-1

algorithm

否

String

样本对齐算法。

OPRF,

SQL_JOIN;

datasets

否

Map<String,String>

样本对齐数据集

align_ids

否

Map<String,String>

样本对齐字段ID集合

agents

否

Array of strings

样本对齐agentId

agent_names

否

Array of strings

样本对齐agentName

dataset_ids

否

Array of strings

样本对齐数据集id集合

large_data_agent

否

String

大数据量参与方agentId，最大32位，由字母和数字组成

job_creation_agent

否

String

作业发起方代理ID，最大32位，由字母和数字组成

encrypted_res

否

Boolean

作业是否加密保存结果

external_param

否

SqlExternalParamDto object

拓展字段
表4 SqlExternalParamDto

参数

是否必选

参数类型

描述

agg.count

否

Integer

此次计算的分布式agg节点数量，最大值2的32次方-1

user.task.memory.size

否

String

本次作业在用户代理节点中分配的内存大小

tics.task.memory.size

否

String

本次作业在tics所属聚合器节点中分配的内存大小

stream.count

否

Integer

本次作业的每批流数量，最大值2的32次方-1

he.dict.enable

否

Boolean

同态加密是否使用字典

save.batch.count

否

Integer

存文件的分批数量，最大值2的32次方-1

max.result.file.size

否

String

最大存文件大小

tics.task.concurrency

否

Integer

tics集群计算节点的并发度，最大值2的32次方-1

user.task.concurrency

否

Integer

用户端数据节点的并发度，最大值2的32次方-1

complex.sql.push.connector

否

Boolean

复杂sql下推到连接器

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

job_instance_id

String

作业实例id，最大长度32

请求示例

执行样本对齐

post https://x.x.x.x:12345/v1/{project_id}/leagues/{league_id}/fl-vertical-jobs/{job_id}/sampleAlignment

{
  "datasets" : {
    "eb6756be3d1e47b08c27b7127cc8e546" : "breast_hetero_mini_host_agent",
    "e7c3efdd9533495d8d5cb9836097b985" : "breast_hetero_mini_guest"
  },
  "align_ids" : {
    "eb6756be3d1e47b08c27b7127cc8e546" : "id",
    "e7c3efdd9533495d8d5cb9836097b985" : "id"
  },
  "agents" : [ "eb6756be3d1e47b08c27b7127cc8e546", "e7c3efdd9533495d8d5cb9836097b985" ],
  "agent_names" : [ "agent_高可用", "agent_dayu_单节点" ],
  "dataset_ids" : [ "8ba00f1ba7fd4f2097f20cb336f64c64", "5afbc2c700f147459b42fc718fb0237c" ],
  "algorithm" : "OPRF",
  "job_instance_type" : "VFL_SAMPLE_ALIGNMENT",
  "league_id" : "8028984ce0b44b1cbdf20dff1ee41466",
  "job_id" : "d6660da0cc53434c92cb5ef8d543e80b",
  "job_name" : "aGDy1"
}

响应示例

状态码： 200

执行样本对齐作业成功

{
  "job_instance_id" : "7b0df147d6464ef2877b22f6d964d274"
}

状态码

状态码

描述

200

执行样本对齐作业成功

401

操作无权限

500

内部服务器错误
父主题： 联邦学习作业管理

相关文档