Skip to content

Latest commit

 

History

History
1350 lines (1154 loc) · 46.2 KB

sdk_reference.md

File metadata and controls

1350 lines (1154 loc) · 46.2 KB
Raw

Paddleflow SDK 使用说明

paddleflow python sdk是基于paddleflow服务封装的sdk python包，对用户、队列、存储、工作流进行统一封装client，开发者可以参考本说明结合自身需求进行使用。

client 初始化

import paddleflow
client = paddleflow.Client("127.0.0.1", "your-username", "your-password", "8999") 
##paddleflow_server_port字段有默认设置值为8999。 如果用户没有修改,在client 初始化时不需要进行传入

接口入参说明

字段名称 字段类型 字段含义
paddleflow_server_host string (required) paddleflow server服务地址
paddleflow_server_port string (optional) paddleflow server端口，默认值为8999

接口返回说明

无

用户登录

ret, response = client.login('username', 'password')

接口入参说明

字段名称 字段类型 字段含义
user_name string (required) 用户名称
password string (required) 用户密码

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回None

用户增加

ret, response = client.add_user('username', 'password')

接口入参说明

字段名称 字段类型 字段含义
user_name string (required) 用户名称
password string (required) 用户密码

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回None

用户删除

ret, response = client.del_user('username')

接口入参说明

字段名称 字段类型 字段含义
user_name string (required) 用户名称

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回None

用户密码更新

ret, response = client.update_password(user_name, password)

接口入参说明

字段名称 字段类型 字段含义
user_name string (required) 用户名称
password string (required) 用户密码

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回None

用户列表展示

ret, response = client.list_user(maxsize=100)

接口入参说明

字段名称 字段类型 字段含义
maxsize int (optional,default=100) 展示列表数量上限，默认值为100

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message(string)，成功返回用户列表userList(list)，每个元素为UserInfo对象，可以参考下面UserInfo类的定义获取对应的成员变量。

用户user类定义

class UserInfo(object):
    """the class of user info"""

    def __init__(self, name, create_time):
        """init """
        self.name = name
        self.create_time = create_time

队列授权

ret, response = client.grant_queue('username', 'queuename')

接口入口参数

字段名称 字段类型 字段含义
username string (required) 被授权用户用户名
queuename string (required) 被授权队列名

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回None

队列取消授权

ret, response = client.ungrant_queue('username', 'queuename')

接口入口参数

字段名称 字段类型 字段含义
username string (required) 被取消授权用户用户名
queuename string (required) 被取消授权队列名

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回None

队列授权列表展示

ret, response = client.show_queue_grant(username, maxsize=100)

接口入口参数

字段名称 字段类型 字段含义
username string (optional) 指定用户，用于过滤指定用户对应的授权信息
maxsize int (optional,default=100) 展示列表数量上限，默认值为100

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回队列列表grantList(list)，每个元素为GrantInfo对象，可以参考下面GrantInfo类的定义获取对应的成员变量。

授权信息GrantInfo类定义

class GrantInfo(object):
    """the class of grant info"""

    def __init__(self, username, resourceName):
        """ init """
        self.username = username
        self.resourceName = resourceName

队列列表展示

ret, response = client.list_queue(maxsize=100)

接口入口参数

字段名称 字段类型 字段含义
maxsize int (optional,default=100) 展示列表数量上限，默认值为100
marker int (optional) 展示下一页的数据

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回队列列表queueList(list)，每个元素为QueueInfo对象，可以参考下面QueueInfo类的定义获取对应的成员变量。

队列queue类定义

class QueueInfo(object):
    """the class of queue info"""   

    def __init__(self, name, status, namespace, mem, cpu, clusterName,  createTime, updateTime):
        """init """
        self.name = name
        self.status = status
        self.namespace = namespace
        self.mem = mem
        self.cpu = cpu
        self.clusterName = clusterName
        self.createTime = createTime
        self.updateTime = updateTime

队列详情展示

ret, response = client.show_queue("queuename")

接口入参说明

字段名称 字段类型 字段含义
queuename string (required) 队列名称

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回队列详情queue，类型为QueueInfo，可以参考上面QueueInfo类的定义获取对应的成员变量。

队列创建

ret, response = client.create_queue("name","namespace","cpu","men","clustername")

接口入参说明

字段名称 字段类型 字段含义
name string (required) 自定义队列名称
namespace string (required) 命名空间
cpu string (required) 最大cpu
men string (required) 最大内存
clustername string (required) 集群名称

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回none

队列停止

ret, response = client.stop_queue("queuename")

接口入参说明

字段名称 字段类型 字段含义
queuename string (required) 队列名称

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回none

队列删除

ret, response = client.del_queue("queuename")

接口入参说明

字段名称 字段类型 字段含义
queuename string (required) 队列名称

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回none

flavour列表显示

ret, response = client.list_flavour()

接口入参说明

字段名称 字段类型 字段含义

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回一个列表

创建存储

ret, response = client.add_fs("fsname", "url")

接口入参说明

字段名称 字段类型 字段含义
fsname string (required) 新建存储系统名称
url string (required) 访问地址如：sftp://192.168.1.2:9000/myfs
username string (optional) 指定用户，用于root用户为其他用户创建fs
properties dict (optional) 后端存储的访问配置项，通过key:value键值对提供。如：S3校验{"accessKey":"test","secretKey":"test"}

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回None

存储详情

ret, response = client.show_fs("fsname")

接口入参说明

字段名称 字段类型 字段含义
fsname string (required) 存储系统名称
username string (optional) 指定用户，用于root用户展示特定用户的fs

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回存储系统详情，类型为FSInfo，可以参考下面FSInfo类的定义获取对应的成员变量。 
class FSInfo(object):
    """the class of fs info"""
    def __init__(self, name, owner, fstype, server_address, subpath, properties):
        """init """
        self.name = name
        self.owner = owner
        self.fstype = fstype
        self.server_adddress = server_address
        self.subpath = subpath
        self.properties = properties

存储列表

ret, response = client.list_fs()

接口入参说明

字段名称 字段类型 字段含义
maxsize int (optional,default=100) 展示列表数量上限，默认值为100
username string (optional) 指定用户，用于root用户列出特定用户的fs

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回存储系统详情List，每个元素的类型为FSInfo，，可以参考上面FSInfo类的定义获取对应的成员变量。

删除存储

ret, response = client.delete_fs("fsname")

接口入参说明

字段名称 字段类型 字段含义
fsname string (required) 存储系统名称
username string (optional) 指定用户，用于admin管理员删除特定用户的fs

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回None

存储挂载

ret, response = client.mount("fsname", "mount_path")

接口入参说明

字段名称 字段类型 字段含义
fsname string (required) 存储系统名称
path string (required) 挂载点名称
username string (optional) 指定用户，用于root用户挂载特定用户的fs

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回None

创建link

ret, response = client.add_link("fsname", "fspath", "url")

接口入参说明

字段名称 字段类型 字段含义
fsname string (required) 关联的存储系统名称
fspath string (required) 需要link到文件系统的目录
url string (required) 外部存储的访问地址如：hdfs://192.168.1.2:9000,192.168.1.3:9000/linkpath
username string (optional) 指定用户，用于root账号创建特定用户的fs的link
properties dict (optional) 外部存储的访问配置项，通过key:value键值对提供。比如HDFS支持透传HDFS的配置项

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回None

删除link

ret, response = client.delete_link("fsname", "fspath")

接口入参说明

字段名称 字段类型 字段含义
fsname string (required) 关联的存储系统名称
fspath string (required) 需要link到文件系统的目录
username string (optional) 指定用户，用于root账号创建特定用户的fs的link

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回None

link详情

ret, response = client.show_link("fsname", "fspath")

接口入参说明

字段名称 字段类型 字段含义
fsname string (required) 关联的存储系统名称
fspath string (required) 需要link到文件系统的目录
username string (optional) 指定用户，用于root账号创建特定用户的fs的link

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回link详情，类型为LinkInfo，可以参考下面LinkInfo类的定义获取对应的成员变量。 
class LinkInfo(object):
    """the class of link info"""
    def __init__(self, name, owner, fstype, fspath, server_address, subpath, properties):
        """init """
        self.name = name
        self.owner = owner
        self.fstype = fstype
        self.fspath = fspath
        self.server_adddress = server_address
        self.subpath = subpath
        self.properties = properties

link列表

ret, response = client.show_link("fsname")

接口入参说明

字段名称 字段类型 字段含义
fsname string (required) 关联的存储系统名称
username string (optional) 指定用户，用于root账号创建特定用户的fs的link
maxsize int (optional,default=100) 展示列表数量上限，默认值为100

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回LinkList(LinkInfo)，每个元素的类型为LinkInfo，可以参考上面LinkInfo类的定义获取对应的成员变量。

工作流创建

ret, response = client.create_run(fsname="fsname", runyamlpath="./run.yaml")

接口入参说明

字段名称 字段类型 字段含义
fs_name string (optional) 共享存储名称
username string (optional) 指定用户，用于root账号运行特定用户的fs的工作流
run_name string (optional) 工作流名称
desc string (optional) 工作流描述
run_yaml_path string (optional) 指定的yaml 文件路径，发起任务方式之一
run_yaml_raw string (optional) 本地yaml 文件路径，发起任务方式之一
pipeline_id string (optional) pipeline模板的ID，发起任务方式之一
pipeline_version_id string(optional) pipeline模板的版本ID，如设置了pipeline_id，则必须同时设置该参数
param dict (optional) 工作流运行参数 如{"epoch":100}
disabled string (optional) 不需要运行的多个步骤，用逗号分割节点名称，如"step1,step2"
docker_env string (optional) 镜像的url或镜像tar包在fs的路径

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回runid

工作流列表

ret, response = client.list_run()

接口入参说明

字段名称 字段类型 字段含义
fs_name string (optional) 共享存储名称，传入只会list出对应fsname的run
username string (optional) 用户名称，传入只会list出指定用户的run
run_id string (optional) runid，传入只会list出指定的run
run_name string (optional) run的名称，传入只会list出拥有对应名称的run
status string (optional) run的状态，传入只会list出指定状态的run
maxsize int (optional,default=100) 展示列表数量上限，默认值为100
marker string (optional) 下一页的起始位置，传入展示下一页，

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回一个dict，{'runList': run列表, 'nextMarker': marker}，列表中每个元素的类型为RunInfo，但仅有部分属性进行了赋值，具体见下表。

list_run返回的每个RunInfo中赋值的属性

字段名称 字段含义
run_id run的id
fs_name 存储名称
username 指定的用户名（仅root用户可以指定）
status run的当前状态
name 名称
desc 描述
run_msg run的信息，通常为运行成功或报错信息
source run的来源，可能为pipeline_id, yaml_path, yaml内容的md5
update_time 更新时间
schedule_id 周期调度的id
scheduled_time 周期调度的时间
create_time run创建的时间
activate_time run开始的时间

工作流详情

ret, response = client.show_run("runid")

接口入参说明

字段名称 字段类型 字段含义
run_id string (required) 需要列出详情的run id

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回run信息，类型为RunInfo，可以参考下面RunInfo类的定义获取对应的成员变量。 
class RunInfo(object):
    """the class of RunInfo info"""   

    def __init__(self, run_id, fs_name, username, status, name, description, parameters,
                 run_yaml, runtime, post_process, docker_env, update_time, source, run_msg, schedule_id, scheduled_time,
                 fs_options, failure_options, disabled, run_cached_ids, create_time, activate_time):
        """init """
        self.run_id = run_id
        self.fs_name = fs_name
        self.username = username
        self.status = status
        self.name = name
        self.description = description
        self.parameters = parameters
        self.run_yaml = run_yaml
        self.runtime = runtime
        self.post_process = post_process
        self.docker_env = docker_env
        self.update_time = update_time
        self.source = source
        self.run_msg = run_msg
        self.fs_options = fs_options
        self.failure_options = failure_options
        self.disabled = disabled
        self.run_cached_ids = run_cached_ids
        self.schedule_id = schedule_id
        self.scheduled_time = scheduled_time
        self.create_time = create_time
        self.activate_time = activate_time

返回的run信息中的runtime中包含了若干DagInfo和JobInfo，它们的结构如下：

class DagInfo(object):
    """ the class of dag info"""

    def __init__(self, dag_id, name, comp_type, dag_name, parent_dag_id, deps, parameters, artifacts, start_time, end_time,
                 status, message, entry_points):
        self.dag_id = dag_id
        self.name = name
        self.type = comp_type
        self.dag_name = dag_name
        self.parent_dag_id = parent_dag_id
        self.deps = deps
        self.parameters = parameters
        self.artifacts = artifacts
        self.start_time = start_time
        self.end_time = end_time
        self.status = status
        self.message = message
        self.entry_points = entry_points

class JobInfo(object):
    """ the class of job info"""
    def __init__(self, name, deps, parameters, command, env, status, start_time, end_time, dockerEnv, jobid):
        self.name = name
        self.deps = deps
        self.parameters = parameters
        self.command = command
        self.env = env
        self.status = status
        self.start_time = start_time
        self.end_time = end_time
        self.dockerEnv = dockerEnv
        self.jobId = jobid

工作流停止

ret, response = client.stop_run("run_id")

接口入参说明

字段名称 字段类型 字段含义
run_id string (required) 需要停止的run id
force bool (optional) 是否停止postProcess

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回None

工作流删除

ret, response = client.delete_run("runid")

接口入参说明

字段名称 字段类型 字段含义
run_id string (required) 需要删除的run id
check_cache bool (optional, default=True) 如果设置为False，则可以删除被Cache的Run，否则不允许

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回None

工作流重试

ret, response = client.retry_run("runid")

接口入参说明

字段名称 字段类型 字段含义
run_id string (required) 需要重试的run id

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回新的run id

工作流缓存列表显示

ret, response = client.list_cache()

接口入参说明

字段名称 字段类型 字段含义
user_filter string (optional) 根据用户筛选工作流缓存，列表显示
fs_filter string (optional) 根据储存筛选工作流缓存，列表显示
run_filter string (optional) 根据run名称筛选工作流缓存，列表显示
maxsize int (optional,default=100) 展示列表数量上限，默认值为100
marker string (optional) 下一页的起始位置，传入展示下一页，

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回 dict: {'runCacheList': RunCacheInfo列表, 'nextMarker': marker}，可以参考下面RunCacheInfo类的定义获取对应的成员变量。

返回信息response中的列表元素结构如下：

class RunCacheInfo(object):
    """ the class of runcache info"""

    def __init__(self, cache_id, first_fp, second_fp, run_id, source, job_id, fs_name, username, expired_time, strategy, custom,
                 create_time, update_time):
        self.cache_id = cache_id
        self.first_fp = first_fp
        self.second_fp = second_fp
        self.run_id = run_id
        self.source = source
        self.job_id = job_id
        self.fs_name = fs_name
        self.username = username
        self.expired_time = expired_time
        self.strategy = strategy
        self.custom = custom
        self.create_time = create_time
        self.update_time = update_time

工作流缓存详情显示

ret, response = client.show_cache("cacheid")

接口入参说明

字段名称 字段类型 字段含义
cache_id string (required) 需要显示详情的cache的id

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回None

工作流缓存删除

ret, response = client.delete_cache("cacheid")

接口入参说明

字段名称 字段类型 字段含义
cache_id string (required) 需要删除的cache的id

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回None

工作流运行产出列表展示

ret, response = client.list_artifact()

接口入参说明

字段名称 字段类型 字段含义
user_filter string (optional) 根据用户筛选产出，列表显示
fs_filter string (optional) 根据储存筛选产出，列表显示
run_filter string (optional) 根据名称筛选产出，列表显示
type_filter string (optional) 根据类型名称筛选产出，列表显示
path_filter string (optional) 根据路径名称筛选产出，列表显示
maxsize int (optional,default=100) 展示列表数量上限，默认值为100
marker string (optional) 下一页的起始位置，传入展示下一页，

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回dict: {'artifactList': artifact列表, 'nextMarker': marker}

工作流模板创建

ret, response = client.create_pipeline()

接口入参说明

字段名称 字段类型 字段含义
fs_name string (required) 共享存储名称
yaml_path string (optional) yaml 文件所在路径
desc string (optional) 工作流模板的描述
username string (optional) 模板所属用户名称

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回dict：{'name': 名称, 'pplID': 工作流模板id, 'pplVerID': 工作流模板版本id}

工作流模板列表显示

ret, response = client.list_pipeline()

接口入参说明

字段名称 字段类型 字段含义
user_filter string (optional) 根据用户筛选工作流模板，列表显示
name_filter string (optional) 根据pipeline名称筛选工作流模板，列表显示
maxsize int (optional,default=50) 展示列表数量上限，默认值为100
marker string (optional) 下一页的起始位置，传入展示下一页

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回dict: {'pipelineList': PipelineInfo列表, 'nextMarker': marker} 可以参考下面PipelineInfo类的定义获取对应的成员变量。

返回信息response中的列表元素结构如下：

class PipelineInfo(object):
    """the class of pipeline info"""
    def __init__(self, pipeline_id, name, username, desc,
                 create_time, update_time):
        """init """
        self.pipeline_id = pipeline_id
        self.name = name
        self.username = username
        self.desc = desc
        self.create_time = create_time
        self.update_time = update_time

工作流模板详情显示

ret, response, ppl_ver_list, marker = client.show_pipeline("pipelineid")

接口入参说明

字段名称 字段类型 字段含义
pipeline_id string (required) 工作流模板id
fs_filter string (optional) 根据存储筛选显示的工作流模板版本信息
max_keys int (optional) 最多显示多少工作流模板版本信息
marker string (optional) 下一页的起始位置

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回 dict: {'pipelineInfo': 工作流模板, 'pipelineVersionList': 工作流模板版本列表, 'nextMarker': marker} 
class PipelineVersionInfo(object):
    """the class of pipeline version info"""
    def __init__(self, pipeline_version_id, pipeline_id, fs_name, yaml_path, pipeline_yaml, username,
                 create_time, update_time):
        self.pipeline_version_id = pipeline_version_id
        self.pipeline_id = pipeline_id
        self.fs_name = fs_name
        self.yaml_path = yaml_path
        self.pipeline_yaml = pipeline_yaml
        self.username = username
        self.create_time = create_time
        self.update_time = update_time

工作流模板删除

ret, response = client.delete_pipeline("pipelineid")

接口入参说明

字段名称 字段类型 字段含义
pipeline_id string (required) 工作流模板id

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回none

工作流模板更新（版本创建）

ret, response, ppl_ver_id = client.update_pipeline("pipeline_id", "fs_name", "yaml_path")

接口入参说明

字段名称 字段类型 字段含义
pipeline_id string (required) 工作流模板id
fs_name string (required) 共享存储名称
yaml_path string (required) yaml 文件所在路径
desc string (optional) 工作流模板的描述
username string (optional) 模板所属用户名称

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回dict: {'pipelineID': pplID, 'pipelineVersionID': pplVerID}

工作流模板版本查看

ret, response, ppl_ver = client.show_pipeline_version("pipeline_id", "pieline_ver_id")

接口入参说明

字段名称 字段类型 字段含义
pipeline_id string (required) 工作流模板id
pipeline_version_id string (required) 工作流模板版本id

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回dict: {'pipelineInfo': 工作流模板, 'pipelineVersionInfo': 工作流模板版本}

工作流模板版本删除

ret, response = client.delete_pipeline_version("pipeline_id", "pieline_ver_id")

接口入参说明

字段名称 字段类型 字段含义
pipeline_id string (required) 工作流模板id
pipeline_version_id string (required) 工作流模板版本id

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回None

周期调度创建

ret, response = client.create_schedule("name", "pipeline_id", "pipeline_ver_id", "* */3 * * *")

接口入参说明

字段名称 字段类型 字段含义
name string (required) 周期调度名称
pipeline_id string (required) 工作流模板id
pipeline_version_id string (required) 工作流模板版本id
crontab string (required) crontab表达式
desc string (optional) 描述
start_time string (optional) 开始时间，格式为'YYYY-MM-DD hh-mm-ss'，不填则立马开始
end_time string (optional) 结束时间，格式同上，不填则永远进行
concurrency int (optional) 并发度
concurrency_policy string (optional) 并发度政策：suspend、replace、skip
expire_interval int (optional) 表示需要恢复的，被miss的周期任务时间段
catchup bool (optional) 是否开启catchup机制
username string (optional) root用户指定的普通用户名称

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response string 失败返回失败message，成功返回scheduleID

周期调度列表查看

ret, response = client.list_schedule()

接口入参说明

字段名称 字段类型 字段含义
user_filter string (optional) 返回指定的用户名对应的周期调度
ppl_filter string (optional) 返回指定的pplID对应的周期调度
ppl_version_filter string (optional) 返回指定的pplVerID对应的周期调度
schedule_filter string (optional) 返回指定的ScheduleID对应的周期调度
name_filter string (optional) 返回指定的ScheduleName对应的周期调度
status_filter string (optional) 返回指定的Status对应的周期调度
marker string (optional) 起始位置
max_keys string (optional) 最大显示数量

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response string 失败返回失败message，成功返回dict: {'scheduleList': 周期调度列表, 'nextMarker': marker}

scheduleList中每一个元素的信息见下ScheduleInfo类

class ScheduleInfo(object):
    """the class of schedule info"""

    def __init__(self, crontab, fs_config, username, pipeline_id, pipeline_version_id,
                 desc, name, schedule_id, options, start_time, end_time, create_time,
                 update_time, next_run_time, message, status):
        self.schedule_id = schedule_id
        self.name = name
        self.desc = desc
        self.pipeline_id = pipeline_id
        self.pipeline_version_id = pipeline_version_id
        self.username = username
        self.fs_config = fs_config
        self.crontab = crontab
        self.options = options
        self.start_time = start_time
        self.end_time = end_time
        self.create_time = create_time
        self.update_time = update_time
        self.next_run_time = next_run_time
        self.message = message
        self.status = status

周期调度查看

ret, response = client.show_schedule("schedule_id")

接口入参说明

字段名称 字段类型 字段含义
schedule_id string (required) 要查看的Schedule的ID
run_filter string (optional) 返回指定的runID对应的Run
status_filter string (optional) 返回指定的Status对应的Run
marker string (optional) 起始位置
max_keys string (optional) 最大显示数量

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response string 失败返回失败message，成功返回dict: {'scheduleInfo': 周期调度, 'runList': run列表, 'nextMarker': marker}

runList中的元素的信息见下RunInfo类

class RunInfo(object):
    """the class of RunInfo info"""   

    def __init__(self, run_id, fs_name, username, status, name, description, parameters,
                 run_yaml, runtime, post_process, docker_env, update_time, source, run_msg, schedule_id, scheduled_time,
                 fs_options, failure_options, disabled, run_cached_ids, create_time, activate_time):
        """init """
        self.run_id = run_id
        self.fs_name = fs_name
        self.username = username
        self.status = status
        self.name = name
        self.description = description
        self.parameters = parameters
        self.run_yaml = run_yaml
        self.runtime = runtime
        self.post_process = post_process
        self.docker_env = docker_env
        self.update_time = update_time
        self.source = source
        self.run_msg = run_msg
        self.fs_options = fs_options
        self.failure_options = failure_options
        self.disabled = disabled
        self.run_cached_ids = run_cached_ids
        self.schedule_id = schedule_id
        self.scheduled_time = scheduled_time
        self.create_time = create_time
        self.activate_time = activate_time

停止周期调度

ret, response = client.stop_schedule("schedule_id")

接口入参说明

字段名称 字段类型 字段含义
schedule_id string (required) 需要停止的schedule的 id

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回None

删除周期调度

ret, response = client.delete_schedule("schedule_id")

接口入参说明

字段名称 字段类型 字段含义
schedule_id string (required) 需要删除的schedule的 id

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回None

集群创建

ret, response = client.create_cluster()

接口入参说明

字段名称 字段类型 字段含义
clustername string (required) 自定义集群名称
endpoint string (required) 集群节点
clustertype string (required) 集群类型，比如kubernetes-v1.16
credential bytes (optional) base64编码后的字符串，用于存储集群的凭证信息，比如k8s的kube_config配置
description string (optional) 集群描述
clusterid string (optional) 集群id，支持外部传入（该值可以是百度云的resource_id，通过resource_id可以获取百度云的floating ip），如果不传则由PF生成
source string (optional) 来源，比如AWS、CCE等
setting string (optional) 额外配置信息
status string (optional) 集群状态, 比如”online”, “offline”，默认值：online
namespacelist string[] (optional) 命名空间列表，比如[“ns1”, “ns2”]

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回cluster id

集群列表显示

ret, response = client.list_cluster()

接口入参说明

字段名称 字段类型 字段含义
clusterstatus string (optional) 根据集群状态筛选
clustername string (optional) 根据集群名称筛选
maxsize int (optional,default=50) 展示列表数量上限，默认值为100
marker string (optional) 下一页的起始位置，传入展示下一页

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回run信息，类型为ClusterInfo，可以参考下面ClusterInfo类的定义获取对应的成员变量。
marker string 存在返回下一页的起始string，否则返回null

返回信息response中的列表元素结构如下：

class ClusterInfo(object):
    """the class of cluster info"""
    def __init__(self, clusterid, clustername, description, endpoint, source, clustertype, status, 
    credential, setting, namespacelist, createtime, updatetime):
        """init """
        self.clusterid = clusterid
        self.clustername = clustername
        self.description = description
        self.endpoint = endpoint
        self.source = source
        self.clustertype = clustertype
        self.status = status
        self.credential = credential
        self.setting = setting
        self.namespacelist = namespacelist
        self.createtime = createtime
        self.updatetime = updatetime

集群详情显示

ret, response = client.show_cluster("clustername")

接口入参说明

字段名称 字段类型 字段含义
clustername string (required) 集群名称

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回cluster对象，参考上面的ClusterInfo结构

集群删除

ret, response = client.delete_cluster("clustername")

接口入参说明

字段名称 字段类型 字段含义
clustername string (required) 集群名称

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功none

集群更新

ret, response = client.update_cluster("clustername")

接口入参说明

字段名称 字段类型 字段含义
clustername string (required) 集群名称
endpoint string (optional) 集群节点
clustertype string (optional) 集群类型，比如kubernetes-v1.16
credential bytes (optional) base64编码后的字符串，用于存储集群的凭证信息，比如k8s的kube_config配置
description string (optional) 集群描述
clusterid string (optional) 集群id，支持外部传入（该值可以是百度云的resource_id，通过resource_id可以获取百度云的floating ip），如果不传则由PF生成
source string (optional) 来源，比如AWS、CCE等
setting string (optional) 额外配置信息
status string (optional) 集群状态, 比如”online”, “offline”，默认值：online
namespacelist string[] (optional) 命名空间列表，比如[“ns1”, “ns2”]

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功集群id

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功none

获取集群资源剩余

ret, response = client.list_cluster_resource()

接口入参说明

字段名称 字段类型 字段含义
clustername string (optional) 集群名称

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功集群剩余资源字典

获取run任务下的运行日志

ret, response = client.show_log("runid")

接口入参说明

字段名称 字段类型 字段含义
runid string (required) 需要展示运行日志的runid
jobid string (optional) 需要展示run下指定job的jobid
pagesize int (optional,default=100) 返回的日志内容的每页行数,默认为100
pageno int (optional,default=1) 返回的日志内容的页数,默认为1
logfileposition string (optional,default=end) 读取日志的顺序,从最开始位置读取为begin,从末尾位置读取为end,默认从尾部开始读取

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回LogInfo的List

response中具体LogInfo结构如下：

class LogInfo(object):

    """the class of log info"""

    def __init__(self, runid, jobid, taskid, has_next_page, truncated, pagesize, pageno, log_content):
        """init """
        # 作业run的id
        self.runid = runid
        # run下子job的id
        self.jobid = jobid
        # job下子task的id
        self.taskid = taskid
        # 日志内容是否还有下一页，为true时则有下一页，否则为最后一页
        self.has_next_page = has_next_page
        # 日志内容是否被截断，为true时则被截断，否则未截断
        self.truncated = truncated
        # 每页日志内容的行数
        self.pagesize = pagesize
        # 日志内容的页数
        self.pageno = pageno
        # 具体的日志内容
        self.log_content = log_content

统计信息获取

ret, response = client.get_statistics("job-run-000075-main-33a69d9b")

接口入参说明

字段名称 字段类型 字段含义
jobid string (required) 需要展示统计信息的jobid
runid string (optional) 需要展示统计信息的runid (尚未支持)

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，成功返回StatisticsJobInfo，参考下面的StatisticsJobInfo结构

response中具体StatisticsJobInfo结构如下：

class StatisticsJobInfo:
    # 指标信息的dict
    metrics_info: Mapping[str, any]

统计信息详情获取

ret, response = client.get_statistics_detail("job-run-000075-main-33a69d9b")

接口入参说明

字段名称 字段类型 字段含义
jobid string (required) 需要展示统计信息的jobid
runid string (optional) 需要展示统计信息的runid (尚未支持)
start int (optional) 需要展示统计信息的起始时间戳，单位为秒
end int (optional) 需要展示统计信息的结束时间戳，单位为秒
step int (optional) 需要展示统计信息的时间间隔，单位为秒

接口返回说明

字段名称 字段类型 字段含义
ret bool 操作成功返回True，失败返回False
response - 失败返回失败message，StatisticsJobDetailInfo，参考下面的StatisticsJobDetailInfo结构
truncated bool 返回的统计信息否被截断，为true时则被截断，否则未截断

response中具体StatisticsJobInfo结构如下：

class StatisticsJobDetailInfo:
    # 返回的结果信息列表
    result: List[Result]
    # 返回的结果是否被截断，如果是被截断过的，值为True
    truncated: bool

class Result:
    # 任务名称
    task_name: str
    # 任务指标的信息列表
    task_info: List[TaskInfo]

class TaskInfo:
    # 指标名称
    metric: str
    # 指标值，返回的是list[timestamp, value]的list
    values: List[List[any]]