实时计算 Flink版_API文档

实时计算 Flink版 - OpenAPI 概览2022-07-18
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
作业草稿文件夹
OpenAPI 名称描述操作
CreateFolder创建文件夹查看文档去调试
UpdateFolder调用本API可完成对文件夹信息的更新查看文档去调试
DeleteFolder删除空文件夹,如果该文件夹下存在其他文件或文件夹则无法删除查看文档去调试
GetFolder获取文件夹的具体信息查看文档去调试
作业草稿
OpenAPI 名称描述操作
CreateDeploymentDraft创建SQL作业的作业草稿查看文档去调试
UpdateDeploymentDraft更新SQL作业草稿查看文档去调试
DeleteDeploymentDraft删除SQL作业草稿,如该草稿存在已经上线或运行中的部署作业,则无法删除查看文档去调试
GetDeploymentDraft获取sql作业草稿详情查看文档去调试
ListDeploymentDrafts获取SQL作业草稿的列表信息查看文档去调试
GetDeploymentDraftLock当您调用API编辑作业草稿时,为避免页面操作和API操作互相影响,您需要先获取编辑锁查看文档去调试
DeployDeploymentDraftAsyncSQL作业草稿部署上线查看文档去调试
GetDeployDeploymentDraftResult根据作业草稿部署异步工单的ID信息,查看部署的结果查看文档去调试
自定义函数
OpenAPI 名称描述操作
CreateUdfArtifact通过对您上传的Jar/Python包的解析,解析您Jar/Python包中全部的UDF方法并为你创建自定义函数文件查看文档去调试
UpdateUdfArtifact对已创建的自定义函数文件进行更新查看文档去调试
GetUdfArtifacts获取您上传并创建的包含UDF的Jar或者Python文件的详情信息查看文档去调试
DeleteUdfArtifact删除已经创建的自定义函数资源,删除前需要您先删除该资源下注册的自定义函数查看文档去调试
DeleteUdfFunction删除已注册的自定义函数查看文档去调试
RegisterUdfFunction通过本API可以选择已创建的自定义函数文件中解析出的自定义函数,选择其中的部分或全部函数进行注册,注册后可在SQL中使用查看文档去调试
自定义连接器
OpenAPI 名称描述操作
ListCustomConnectors获取已注册的自定义连接器的列表信息查看文档去调试
RegisterCustomConnector在项目空间下注册自定义连接器,注册的自定义连接器可以在SQL中使用查看文档去调试
DeleteCustomConnector删除已经注册的自定义连接器查看文档去调试
元数据
OpenAPI 名称描述操作
GetDatabases获取指定Catalog下DataBase的信息或列出所有DataBase的信息查看文档去调试
GetTables获取指定catalog的database下某张表的具体详情或者database下所有表的信息查看文档去调试
GetCatalogs获取指定或全部catalog详情查看文档去调试
ExecuteSqlStatement您可以通过本API完成元数据相关SQL的运行,仅支持DDL和DML,不支持DQL查看文档去调试
快照
OpenAPI 名称描述操作
CreateSavepoint创建快照查看文档去调试
GetSavepoint获取快照和系统检查点的详细信息查看文档去调试
DeleteSavepoint删除快照查看文档去调试
ListSavepoints获取作业快照及最近系统检查点列表查看文档去调试
已部署作业
OpenAPI 名称描述操作
CreateDeploymenthot创建一个已部署作业查看文档去调试
UpdateDeploymenthot更新已部署作业的信息查看文档去调试
GetDeploymenthot获取已部署作业的详细信息查看文档去调试
ListDeploymentshot获取所有已部署作业的信息查看文档去调试
DeleteDeployment根据已部署作业ID删除已部署作业查看文档去调试
GetEvents获取运行事件查看文档去调试
作业实例
OpenAPI 名称描述操作
GetJobhot获取作业实例的详细信息查看文档去调试
ListJobshot获取到某个已部署作业下所有作业实例的信息查看文档去调试
StartJobWithParamshot启动一个作业实例查看文档去调试
StopJobhot停止一个作业实例查看文档去调试
DeleteJob删除一个作业下非运行状态的作业实例信息查看文档去调试
HotUpdateJob对正在运行的作业进行参数或资源的动态更新查看文档去调试
GetHotUpdateJobResult对作业进行动态更新时,可通过本API获取作业动态更新的结果查看文档去调试
GetLatestJobStartLog获取作业实例最新的启动日志查看文档去调试
deprecatedStartJobhot创建并启动一个作业实例查看文档去调试
定时计划
OpenAPI 名称描述操作
CreateScheduledPlan创建定时计划查看文档去调试
UpdateScheduledPlan更新定时计划查看文档去调试
DeleteScheduledPlan删除定时计划查看文档去调试
ListScheduledPlan获取定时计划的列表信息查看文档去调试
ApplyScheduledPlan执行定时计划查看文档去调试
StopApplyScheduledPlan停止应用定时计划查看文档去调试
GetAppliedScheduledPlan获取应用的执行计划查看文档去调试
ListScheduledPlanExecutedHistory获取定时计划执行历史查看文档去调试
Session集群
OpenAPI 名称描述操作
CreateSessionCluster创建Session集群查看文档去调试
UpdateSessionCluster更新Session集群查看文档去调试
DeleteSessionCluster删除Session集群查看文档去调试
GetSessionCluster获取Session集群查看文档去调试
ListSessionClusters获取Session集群的列表信息查看文档去调试
StartSessionCluster启动Session集群查看文档去调试
StopSessionCluster停止Session集群查看文档去调试
作业部署目标
OpenAPI 名称描述操作
CreateDeploymentTarget创建部署目标查看文档去调试
UpdateDeploymentTarget更新部署目标查看文档去调试
DeleteDeploymentTarget删除部署目标查看文档去调试
ListDeploymentTargets获取作业可部署目标的列表,部署目标是session集群或者perjob集群查看文档去调试
成员管理
OpenAPI 名称描述操作
CreateMember将一个用户添加到对应项目空间下并授予对应权限查看文档去调试
UpdateMember更新特定项目空间下某个或某些用户的权限查看文档去调试
DeleteMember删除指定的用户权限信息查看文档去调试
GetMember查看用户授权详情查看文档去调试
ListMembers查看特定项目下用户UID和授权的对应关系查看文档去调试
变量
OpenAPI 名称描述操作
UpdateVariable修改项目级别的变量查看文档去调试
CreateVariable创建变量查看文档去调试
DeleteVariable删除变量查看文档去调试
ListVariableshot获取变量列表查看文档去调试
其他
OpenAPI 名称描述操作
GetJobDiagnosis智能诊断作业,获取异常诊断项信息查看文档去调试
ListEngineVersionMetadata获取系统支持的引擎版本列表查看文档去调试
ValidateSqlStatement校验sql作业代码查看文档去调试
GenerateResourcePlanWithFlinkConfAsync提交异步生成resource plan工单,返回一个异步工单ID用于查询工单结果查看文档去调试
GetGenerateResourcePlanResult根据异步工单ID获取异步生成细粒度资源结果查看文档去调试
FlinkApiProxy您可以使用flink rest api的方式来调用本接口,获取session集群或者运行作业的相关信息。注意本接口仅支持您获取相关信息,无法对session集群和作业进行操作或管理查看文档去调试
GetLineageInfo通过本API可以获取作业和数据的血缘信息查看文档去调试