本产品（
实时计算 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获取异步生成细粒度资源结果。 |
| FlinkApiProxy | Flink请求代理 | 代理Flink请求，获取请求结果。 |
| GenerateResourcePlanWithFlinkConfAsync | 异步生成细粒度资源 | 提交异步生成resource plan工单，返回一个异步工单ID用于查询工单结果。 |