本产品（
实时计算 Flink版/2022-07-18）的OpenAPI采用ROA签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
作业草稿文件夹
| API | 标题 | API概述 |
|---|---|---|
| CreateFolder | 创建文件夹 | 创建文件夹。 |
| UpdateFolder | 更新文件夹 | 调用本API可完成对文件夹信息的更新。 |
| DeleteFolder | 删除文件夹 | 删除空文件夹，如果该文件夹下存在其他文件或文件夹则无法删除。 |
| GetFolder | 获取文件夹信息 | 获取文件夹的具体信息。 |
作业草稿
| API | 标题 | API概述 |
|---|---|---|
| CreateDeploymentDraft | 创建作业草稿 | 创建SQL作业的作业草稿。 |
| UpdateDeploymentDraft | 更新作业草稿 | 更新SQL作业草稿。 |
| DeleteDeploymentDraft | 删除作业草稿 | 删除SQL作业草稿，如该草稿存在已经上线或运行中的部署作业，则无法删除。 |
| GetDeploymentDraft | 获取作业草稿详情 | 获取sql作业草稿详情。 |
| ListDeploymentDrafts | 查看作业草稿列表 | 获取SQL作业草稿的列表信息。 |
| GetDeploymentDraftLock | 获取作业草稿编辑锁 | 当您调用API编辑作业草稿时，为避免页面操作和API操作互相影响，您需要先获取编辑锁。 |
| DeployDeploymentDraftAsync | 部署作业草稿 | SQL作业草稿部署上线。 |
| GetDeployDeploymentDraftResult | 获取作业草稿部署结果 | 根据作业草稿部署异步工单的ID信息，查看部署的结果。 |
自定义函数
| API | 标题 | API概述 |
|---|---|---|
| CreateUdfArtifact | 创建自定义函数文件 | 通过对您上传的Jar/Python包的解析，解析您Jar/Python包中全部的UDF方法并为你创建自定义函数文件。 |
| UpdateUdfArtifact | 更新自定义函数文件 | 对已创建的自定义函数文件进行更新。 |
| GetUdfArtifacts | 获取自定义函数资源详情 | 获取您上传并创建的包含UDF的Jar或者Python文件的详情信息。 |
| DeleteUdfArtifact | 删除自定义函数资源 | 删除已经创建的自定义函数资源，删除前需要您先删除该资源下注册的自定义函数。 |
| DeleteUdfFunction | 删除自定义函数 | 删除已注册的自定义函数。 |
| RegisterUdfFunction | 注册自定义函数 | 通过本API可以选择已创建的自定义函数文件中解析出的自定义函数，选择其中的部分或全部函数进行注册，注册后可在SQL中使用。 |
自定义连接器
| API | 标题 | API概述 |
|---|---|---|
| ListCustomConnectors | 获取自定义连接器列表 | 获取已注册的自定义连接器的列表信息。 |
| RegisterCustomConnector | 注册自定义连接器 | 在项目空间下注册自定义连接器，注册的自定义连接器可以在SQL中使用。 |
| DeleteCustomConnector | 删除自定义连接器 | 删除已经注册的自定义连接器。 |
元数据
| API | 标题 | API概述 |
|---|---|---|
| GetDatabases | 获取Database信息 | 获取指定Catalog下DataBase的信息或列出所有DataBase的信息。 |
| GetTables | 获取表信息 | 获取指定catalog的database下某张表的具体详情或者database下所有表的信息。 |
| GetCatalogs | 获取Catalog信息 | 获取指定或全部catalog详情。 |
| ExecuteSqlStatement | 执行元数据SQL语句 | 您可以通过本API完成元数据相关SQL的运行，仅支持DDL和DML，不支持DQL。 |
快照
| API | 标题 | API概述 |
|---|---|---|
| CreateSavepoint | 创建快照 | 创建快照。 |
| GetSavepoint | 获取快照和系统检查点 | 获取快照和系统检查点的详细信息。 |
| DeleteSavepoint | 删除快照 | 删除快照。 |
| ListSavepoints | 获取作业快照及系统检查点列表 | 获取作业快照及最近系统检查点列表。 |
已部署作业
| API | 标题 | API概述 |
|---|---|---|
| CreateDeployment | 创建已部署作业 | 创建一个已部署作业。 |
| UpdateDeployment | 更新已部署作业 | 更新已部署作业的信息。 |
| GetDeployment | 获取已部署作业 | 获取已部署作业的详细信息。 |
| ListDeployments | 获取已部署作业列表 | 获取所有已部署作业的信息。 |
| DeleteDeployment | 删除已部署作业 | 根据已部署作业ID删除已部署作业。 |
| GetEvents | 获取运行事件 | 获取运行事件。 |
作业实例
| API | 标题 | API概述 |
|---|---|---|
| GetJob | 获取作业实例 | 获取作业实例的详细信息。 |
| ListJobs | 获取作业实例列表 | 获取到某个已部署作业下所有作业实例的信息。 |
| StartJobWithParams | 启动作业实例 | 启动一个作业实例。 |
| StopJob | 停止作业实例 | 停止一个作业实例。 |
| DeleteJob | 删除作业实例 | 删除一个作业下非运行状态的作业实例信息。 |
| HotUpdateJob | 动态更新作业 | 对正在运行的作业进行参数或资源的动态更新。 |
| GetHotUpdateJobResult | 获取作业动态更新结果 | 对作业进行动态更新时，可通过本API获取作业动态更新的结果。 |
| GetLatestJobStartLog | 获取最新作业实例的启动日志 | 获取作业实例最新的启动日志。 |
| StartJob | 启动作业实例（废弃） | 创建并启动一个作业实例。 |
定时计划
| API | 标题 | API概述 |
|---|---|---|
| CreateScheduledPlan | 创建定时计划 | 创建定时计划。 |
| UpdateScheduledPlan | 更新定时计划 | 更新定时计划。 |
| DeleteScheduledPlan | 删除定时计划 | 删除定时计划。 |
| ApplyScheduledPlan | 应用定时计划 | 执行定时计划。 |
| StopApplyScheduledPlan | 停止应用定时计划 | 停止应用定时计划。 |
| GetAppliedScheduledPlan | 获取应用的定时计划 | 获取应用的执行计划。 |
| ListScheduledPlanExecutedHistory | 获取定时计划执行历史 | 获取定时计划执行历史。 |
Session集群
| API | 标题 | API概述 |
|---|---|---|
| CreateSessionCluster | 创建Session集群 | 创建Session集群。 |
| UpdateSessionCluster | 更新Session集群 | 更新Session集群。 |
| DeleteSessionCluster | 删除Session集群 | 删除Session集群。 |
| GetSessionCluster | 获取Session集群 | 获取Session集群。 |
| ListSessionClusters | 获取Session集群列表 | 获取Session集群的列表信息。 |
| StartSessionCluster | 启动Session集群 | 启动Session集群。 |
| StopSessionCluster | 停止Session集群 | 停止Session集群。 |
作业部署目标
| API | 标题 | API概述 |
|---|---|---|
| CreateDeploymentTarget | 创建部署目标 | 创建部署目标。 |
| UpdateDeploymentTarget | 更新部署目标 | 更新部署目标。 |
| DeleteDeploymentTarget | 删除部署目标 | 删除部署目标。 |
| ListDeploymentTargets | 获取部署目标列表 | 获取作业可部署目标的列表，部署目标是session集群或者perjob集群。 |
成员管理
| API | 标题 | API概述 |
|---|---|---|
| CreateMember | 新增成员授权 | 将一个用户添加到对应项目空间下并授予对应权限。 |
| UpdateMember | 更新用户授权信息 | 更新特定项目空间下某个或某些用户的权限。 |
| DeleteMember | 删除用户权限 | 删除指定的用户权限信息。 |
| GetMember | 查看成员授权信息 | 查看用户授权详情。 |
| ListMembers | 查看项目下成员授权列表 | 查看特定项目下用户UID和授权的对应关系。 |
变量
| API | 标题 | API概述 |
|---|---|---|
| CreateVariable | 创建变量 | 创建变量。 |
| DeleteVariable | 删除变量 | 删除变量。 |
| ListVariables | 获取变量列表 | 获取变量列表。 |
其他
| API | 标题 | API概述 |
|---|---|---|
| ListEngineVersionMetadata | 获取引擎版本列表 | 获取系统支持的引擎版本列表。 |
| ValidateSqlStatement | 验证sql语句 | 校验sql作业代码。 |
| GenerateResourcePlanWithFlinkConfAsync | 异步生成细粒度资源 | 提交异步生成resource plan工单，返回一个异步工单ID用于查询工单结果。 |
| GetGenerateResourcePlanResult | 获取异步生成细粒度资源结果 | 根据异步工单ID获取异步生成细粒度资源结果。 |
| FlinkApiProxy | Flink Rest API代理 | 您可以使用flink rest api的方式来调用本接口，获取session集群或者运行作业的相关信息。注意本接口仅支持您获取相关信息，无法对session集群和作业进行操作或管理。 |
| GetLineageInfo | 获取血缘信息 | 通过本API可以获取作业和数据的血缘信息。 |