文档首页 > > API参考> API概览

API概览

分享
更新时间: 2019/05/27 21:05

FunctionGraph API为开发者、合作伙伴提供开发、部署、托管、运维的开放接口,帮助用户快速、低成本地实现业务创新,缩短应用上线周期。

FunctionGraph API提供的接口有如下几种类型。

表1 接口简介

类型

说明

函数管理域接口

函数的管理域接口,包括函数获取、创建、修改、发布等。

函数数据域接口

函数的数据域接口,包括同步执行函数和异步执行函数。

工作流配额管理接口

配额管理接口,包括查询租户的触发器配额和工作流配额、默认的触发器配额和工作流配额。

工作流触发器管理接口

触发器管理接口,包括触发器的创建、查询、更新、删除等。

工作流管理接口

工作流管理接口,包括工作流的创建、删除、查询、更新等。

Mapping管理接口

Mapping管理接口,包括Mapping的创建、删除、查询等。

工作流定时器管理接口

定时器管理接口,包括定时器的绑定、更新、删除、查询等。

工作流运行实例管理接口

运行实例管理接口,包括运行实例的启停、查询等。

工作流测试功能接口

工作流测试功能接口,包括工作流的启动、模拟。

工作流触发器消息管理接口

触发器消息管理,Worker发送触发器消息。

函数管理域接口

表2 管理域接口

API

说明

获取函数列表

获取函数列表。

获取函数的metadata

获取指定函数的metadata。

获取指定函数代码

获取指定函数的代码。

创建函数

创建指定的函数。

删除函数/版本

删除指定的函数或者特定的版本(不允许删除latest版本)。

修改函数代码

修改指定的函数的代码。

修改函数的metadata信息

修改指定的函数的metadata信息。

发布函数版本

发布函数版本。

获取指定函数的版本列表

获取指定函数的版本列表。

创建函数版本别名

创建函数版本别名。

修改函数版本别名信息

修改函数版本别名信息。

删除函数版本别名

删除函数版本别名。

获取函数版本的指定别名信息

获取函数指定的版本别名信息。

获取指定函数所有版本别名列表

获取函数版本别名列表。

获取指定函数的所有触发器

获取指定函数的所有触发器设置。

获取指定触发器的信息

获取特定触发器的信息。

删除指定函数的所有触发器

删除指定函数所有触发器设置。

创建触发器

创建触发器。

删除触发器

删除触发器。

函数数据域接口

表3 数据域接口

API

说明

同步执行函数

同步执行函数。

异步执行函数

异步执行函数。

工作流配额管理接口

表4 配额管理接口

API

说明

查询租户的工作流触发器配额

查询租户能够创建的触发器的配额。

查询默认的工作流触发器配额

查询默认的触发器配额,该默认配额为该Region内的系统配置。

查询租户工作流配额

查询租户创建工作流的配额信息。

查询默认的工作流配额

查询默认的工作流配额信息,该配置为Region级别的系统配置。

工作流触发器管理接口

表5 触发器管理接口

API

说明

创建工作流触发器

创建一个触发器。

查询工作流触发器

查询触发器详细信息。

查询工作流触发器列表

依据输入的查询参数,查询多个触发器,返回所需触发器详细信息列表。

更新工作流触发器

更新一个触发器的信息。

删除工作流触发器

删除一个触发器。

工作流触发器批量操作

根据给定的触发器列表,进行相应的批量操作。

工作流管理接口

表6 工作流管理接口

API

说明

创建工作流

创建一个工作流。

删除工作流

删除指定的工作流,同时会删除该工作流对应的所有运行实例。

查询工作流列表

查询当前租户下所有的工作流列表。

查询指定工作流的信息

查询指定的工作流的相关信息。

更新工作流定义

更新一个工作流的定义。

查询指定实例运行的工作流的信息

查询指定实例运行的工作流相关信息。

Mapping管理接口

表7

API

说明

创建Mapping

创建一个触发器-工作流Mapping。

删除Mapping

删除一个触发器-工作流Mapping。

启用、禁用Mapping

启用或禁用一个触发器-工作流Mapping。

查询Mapping详情

查询指定的触发器Mapping的相关信息。

查询Mapping列表

依据输入的查询参数,查询多个触发器Mapping,返回所需触发器Mapping详细信息列表。

工作流定时器管理接口

表8 定时器管理接口

API

说明

绑定工作流定时器

创建一个定时器,并将其与工作流绑定。

更新工作流定时器

更新定时器定义。

启动/停止工作流定时器

启动/停止定时器。

删除工作流定时器

删除定时器。

查询工作流定时器

查询与一个工作流绑定的所有定时器列表。

工作流运行实例管理接口

表9 运行实例管理接口

API

说明

启动工作流运行实例

启动一个运行实例。

停止工作流运行实例

停止一个运行实例的执行。

查询工作流运行实例列表

查询指定工作流的运行实例列表。

查询指定工作流运行实例的信息

查询指定运行实例的元数据。

查询指定工作流运行实例的历史信息

查询指定execution的流转历史信息。

工作流测试功能接口

表10 工作流测试功能接口

API

说明

启动工作流测试实例

启动一个测试运行实例。

模拟事件消息触发event state

模拟一个事件消息,触发指定的event state。

工作流触发器消息管理接口

表11 触发器消息管理接口

API

说明

Worker发送触发器消息

Worker事件源向FunctionGraph服务发送触发器消息。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区