API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (ververica/2022-07-18) follows the ROA standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
API list
|
API |
Title |
Description |
| UpdateDeploymentTargetV2 | Update Deployment Target (V2) | Updates a deployment target. |
| CreateDeploymentTargetV2 | Create Deployment Target (V2) | Creates a deployment target. |
Job Draft Folder
|
API |
Title |
Description |
| CreateFolder | CreateFolder | Creates a folder. |
| UpdateFolder | UpdateFolder | Updates a folder. |
| DeleteFolder | DeleteFolder | Deletes an empty folder. If files or folders exist in a folder, the folder cannot be deleted. |
| GetFolder | Obtain Folder Information | Retrieves specific folder information. |
Job Draft
|
API |
Title |
Description |
| ValidateDeploymentDraftAsync | ValidateDeploymentDraftAsync | Asynchronously performs an in-depth check of a Flink job draft to validate its syntax and resource configuration. |
| GetValidateDeploymentDraftResult | GetValidateDeploymentDraftResult | Queries the depth validation result of a job draft by ticket ID. |
| CreateDeploymentDraft | CreateDeploymentDraft | Creates a draft for an SQL job. |
| UpdateDeploymentDraft | Update a job draft | Updates the draft of an SQL job. |
| DeleteDeploymentDraft | Delete Job Draft | Deletes a draft of an SQL job. You cannot delete a draft that has a published or running deployment. |
| GetDeploymentDraft | Obtain job draft details | Retrieves the details of an SQL job draft. |
| ListDeploymentDrafts | View job draft list | Retrieve the list information of SQL job drafts. |
| GetDeploymentDraftLock | Obtain Edit Lock for Job Draft | When you call the API to edit a job draft, first obtain an edit lock to prevent conflicts between page operations and API operations. |
| DeployDeploymentDraftAsync | Deploy a job draft | Deploy and publish an SQL job draft. |
| GetDeployDeploymentDraftResult | Get Job Draft Deployment Result | Checks the deployment result of a job draft using an asynchronous ticket ID. |
Custom-Defined Functions
|
API |
Title |
Description |
| DeleteUdfArtifact | Delete User-Defined Function Resource | Deletes a user-defined function (UDF) resource. You must delete all UDFs registered with the resource before you can delete the resource. |
Metadata
|
API |
Title |
Description |
| GetDatabases | GetDatabases | Retrieves information about one or more databases in a specified catalog. |
| GetTables | Obtain Table Information | Retrieves the details of a specific table or all tables in a database within a specified catalog. |
| GetCatalogs | GetCatalogs | Retrieves the details of a specified catalog or all catalogs. |
| ExecuteSqlStatement | ExecuteSqlStatement | Executes Data Definition Language (DDL) and Data Manipulation Language (DML) statements on metadata. Data Query Language (DQL) is not supported. |
Deployed Job
|
API |
Title |
Description |
| GetDeploymentsByName | GetDeploymentsByName | Retrieves deployed job instances by name from a specified workspace and project. |
| GetDeploymentsByLabel | GetDeploymentsByLabel | Queries a list of deployed jobs and their information by a specified label. |
| GetDeploymentsByIp | GetDeploymentsByIp | This operation queries for a list of deployed jobs and their information on a node by a specified IP address. |
| ListDeployments | Retrieve the list of deployed jobs | Retrieve information about all deployed jobs. |
| GetEvents | Retrieve management events | Retrieves runtime events. |
Job instance
|
API |
Title |
Description |
| GetHotUpdateJobResult | Obtain the Result of a Dynamic Job Update | You can call this API to retrieve the result of a hot update for a job. |
| GetJobDiagnosis | Get Job Diagnosis Details | Diagnoses a job and retrieves information about abnormal diagnostic items. |
Scheduled plans
|
API |
Title |
Description |
| CreateScheduledPlan | Create a scheduled plan | Creates a scheduled plan. |
| UpdateScheduledPlan | Update a scheduled plan | Updates a scheduled plan. |
| DeleteScheduledPlan | Delete a scheduled plan | Deletes a scheduled plan. |
| ListScheduledPlan | Retrieve the list of scheduled plans | Lists scheduled plans. |
| ApplyScheduledPlan | Application Scheduled Plan | This operation applies a scheduled plan. |
| StopApplyScheduledPlan | Stop a scheduled plan for an application | Stops the application of a scheduled plan. |
| GetAppliedScheduledPlan | Obtain the scheduled plan of an application | Retrieves the execution plan for an application. |
| ListScheduledPlanExecutedHistory | Retrieve Scheduled Job Execution History | Retrieves the execution history of a scheduled plan. |
Session Cluster
|
API |
Title |
Description |
| CreateSessionCluster | Create a session cluster | Creates a session cluster. |
| UpdateSessionCluster | Update Session Cluster | Updates a session cluster. |
| DeleteSessionCluster | Delete Session Cluster | Deletes a session cluster. |
| GetSessionCluster | Retrieve a session cluster | Retrieves a session cluster. |
| ListSessionClusters | Retrieve Session Cluster List | This operation lists session clusters. |
| StartSessionCluster | Start Session Cluster | Starts a session cluster. |
| StopSessionCluster | Stop Session Cluster | Stops a session cluster. |
Job Deployment Target
|
API |
Title |
Description |
| CreateDeploymentTarget | Create Deployment Target | Creates a deployment target. |
| UpdateDeploymentTarget | Update Deployment Target | Updates a deployment target. |
| DeleteDeploymentTarget | Delete Deployment Target | Deletes a deployment target. |
Variable
|
API |
Title |
Description |
| UpdateVariable | UpdateVariable | Updates the information about a variable in a namespace. |
Others
|
API |
Title |
Description |
| CreateDeployment | CreateDeployment | Creates a deployment. |
| CreateMember | CreateMember | Adds a user to a namespace as a member and grants permissions to the user. |
| CreateSavepoint | CreateSavepoint | Creates a savepoint. |
| CreateUdfArtifact | CreateUdfArtifact | Parses all user-defined function (UDF) methods in your JAR or Python file and creates an artifact configuration for a UDF. |
| CreateVariable | CreateVariable | Creates a variable. |
| DeleteCustomConnector | DeleteCustomConnector | Deletes a registered custom connector from a workspace. |
| DeleteDeployment | DeleteDeployment | Deletes a deployment based on the deployment ID. |
| DeleteJob | DeleteJob | Deletes the information about a job that is not in the running state in a deployment. |
| DeleteMember | DeleteMember | Revokes the permissions from a member. |
| DeleteSavepoint | DeleteSavepoint | Deletes a savepoint. |
| DeleteUdfFunction | DeleteUdfFunction | Deletes an existing user-defined function (UDF) from a Realtime Compute for Apache Flink workspace. |
| DeleteVariable | DeleteVariable | Deletes a variable. |
| FlinkApiProxy | FlinkApiProxy | Provides a proxy for Realtime Compute for Apache Flink requests. |
| GenerateResourcePlanWithFlinkConfAsync | GenerateResourcePlanWithFlinkConfAsync | Submits a ticket that applies for asynchronous generation of the fine-grained resources. This operation returns the ID of the ticket for you to query the asynchronous generation result. |
| GetDeployment | GetDeployment | Obtains the details of a deployment. |
| GetGenerateResourcePlanResult | GetGenerateResourcePlanResult | Obtains the asynchronous generation result of fine-grained resources based on the ID of the ticket that applies for an asynchronous generation. |
| GetJob | GetJob | Retrieves detailed information about a job instance. |
| GetLatestJobStartLog | GetLatestJobStartLog | Obtains the latest startup logs of a job. |
| GetLineageInfo | GetLineageInfo | Obtains the lineage information of a deployment. |
| GetMember | GetMember | Queries the permissions of a member. |
| GetSavepoint | GetSavepoint | Queries details of a savepoint and checkpoint. |
| GetUdfArtifacts | GetUdfArtifacts | Obtains the details of the JAR or Python file that corresponds to the user-defined function (UDF) that you upload and create. |
| HotUpdateJob | HotUpdateJob | Dynamically updates parameters or resources of a deployment that is running. |
| ListCustomConnectors | ListCustomConnectors | Obtains a list of existing custom connectors. |
| ListDeploymentTargets | ListDeploymentTargets | Obtains a list of clusters in which deployments can be deployed. The cluster can be a session cluster or a per-job cluster. |
| ListEngineVersionMetadata | ListEngineVersionMetadata | Obtains a list of engine versions that are supported by Realtime Compute for Apache Flink. |
| ListJobs | ListJobs | Retrieve information about all job instances under a deployed job. |
| ListMembers | ListMembers | Queries the mappings between the ID and permissions of a member in a specific namespace. |
| ListSavepoints | ListSavepoints | Obtains a list of savepoints or checkpoints. |
| ListVariables | ListVariables | Obtains a list of variables. |
| RegisterCustomConnector | RegisterCustomConnector | Registers a custom connector in a namespace. The registered custom connector can be used in SQL statements. |
| RegisterUdfFunction | RegisterUdfFunction | Registers specific or all of the user-defined functions (UDFs) that are parsed from the JAR files. The registered functions can be used in SQL statements. |
| StartJob | StartJob | Creates and starts a job instance. |
| StartJobWithParams | StartJobWithParams | Starts a job instance. |
| StopJob | StopJob | Stops a job instance. |
| UpdateDeployment | UpdateDeployment | Updates information about a deployment. |
| UpdateMember | UpdateMember | Updates the permissions of one or more members in a specific namespace. |
| UpdateUdfArtifact | UpdateUdfArtifact | Updates the JAR file of the user-defined function (UDF) that you create. |
| ValidateSqlStatement | ValidateSqlStatement | Verifies the code of an SQL deployment. |