FlowFederateSDK

Introduction¶

我们将介绍如何使用flow_federate_sdksdk库与iflearner_flow_federate服务进行交互。

Installation¶

您可以执行下述命令进行快速安装:

pip install iflearner-flow-client

然后, 您就可以引用flow_federate_sdk库进行接口调用

Initialization¶

我们需要先初始化操作，主要是完成配置连接服务的相关参数, 生成一个client对象。

Parameters

parameter	required	type	description
host	yes	string	The host for connecting `iflearner_flow_federate` server
port	yes	string	The port for connecting `iflearner_flow_federate` server

Usage

from flow_federate_sdk import FlowFederateSdk
# use real ip address to initialize SDK
flow_federate_client = FlowFederateSdk(host="127.0.0.1", port="1235")

Task¶

List¶

获取任务列表

Function

list(
    cls, 
    keyword: str, 
    page: int = 1, 
    limit: int = 10
)-> Dict[str, Any]

Parameters

参数	必填	类型	说明
name	yes	string	任务名称
template_id	yes	string	任务关联的模板id
remark	no	string	任务备注信息
federate_data	yes	array	任务关联的联邦方信息