文档

API概览

更新时间:
本产品(实时计算 Flink版/2022-07-18)的OpenAPI采用ROA签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

变量

API标题API概述
ListVariables获取变量列表获取变量列表。
DeleteVariable删除变量删除变量。
CreateVariable创建变量创建变量。

快照

API标题API概述
GetSavepoint获取快照获取快照详细信息。
DeleteSavepoint删除快照删除快照。
CreateSavepoint创建快照创建快照。
ListSavepoints获取作业快照列表获取作业快照列表。

作业实例

API标题API概述
StopJob停止作业实例停止一个作业实例。
StartJobWithParams启动作业实例启动一个作业实例。
StartJob启动作业实例(废弃)创建并启动一个作业实例。
GetJob获取作业实例获取作业实例的详细信息。
DeleteJob删除作业实例删除一个作业下非运行状态的作业实例信息。
ListJobs获取作业实例列表获取到某个已部署作业下所有作业实例的信息。

作业部署目标

API标题API概述
ListDeploymentTargets获取部署目标列表获取作业可部署目标的列表,部署目标是session集群或者perjob集群。

已部署作业

API标题API概述
UpdateDeployment更新已部署作业更新已部署作业的信息。
DeleteDeployment删除已部署作业根据已部署作业ID删除已部署作业。
ListDeployments获取已部署作业列表获取所有已部署作业的信息。
GetDeployment获取已部署作业获取已部署作业的详细信息。
CreateDeployment创建已部署作业创建一个已部署作业。

成员管理

API标题API概述
CreateMember新增成员授权将一个用户添加到对应项目空间下并授予对应权限。
DeleteMember删除用户权限删除指定的用户权限信息。
GetMember查看成员授权信息查看用户授权详情。
ListMembers查看项目下成员授权列表查看特定项目下用户UID和授权的对应关系。
UpdateMember更新用户授权信息更新特定项目空间下某个或某些用户的权限。

其它

API标题API概述
ListEngineVersionMetadata获取引擎版本列表获取系统支持的引擎版本列表。
GetGenerateResourcePlanResult获取异步生成细粒度资源结果根据异步工单ID获取异步生成细粒度资源结果。
FlinkApiProxyFlink请求代理代理Flink请求,获取请求结果。
GenerateResourcePlanWithFlinkConfAsync异步生成细粒度资源提交异步生成resource plan工单,返回一个异步工单ID用于查询工单结果。
  • 本页导读 (1)