API standards and multilingual preset SDKs
The OpenAPI of this product (ververica/2022-07-18) uses the ROA signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Job draft folder
|
API |
Title |
Description |
| CreateFolder | Create a folder | Creates a folder. |
| UpdateFolder | Update a folder | Updates the information of a folder. |
| DeleteFolder | DeleteFolder | Deletes an empty folder. If files or folders exist in a folder, the folder cannot be deleted. |
| GetFolder | Get folder information | Retrieves the details of a specific folder. |
Job drafts
|
API |
Title |
Description |
| CreateDeploymentDraft | Create a job draft | Creates a draft for SQL and data ingestion jobs. |
| DeleteDeploymentDraft | Delete a job draft | Deletes a draft of an SQL or data ingestion job. You cannot delete the draft if it is associated with an online or running deployment job. |
| UpdateDeploymentDraft | Update a job draft | Updates the draft of an SQL or data ingestion job. |
| GetDeploymentDraft | Obtain job draft details | Retrieves the details of an SQL or data ingestion job draft. |
| DeployDeploymentDraftAsync | Deploy a job draft | Deploys a draft of an SQL job. |
| GetDeployDeploymentDraftResult | Get Job Draft Deployment Result | Checks the deployment result of a job draft. |
| ValidateSqlStatement | ValidateSqlStatement | Verifies the code of an SQL deployment. |
| ListDeploymentDrafts | View job draft list | Retrieves a list of SQL or data ingestion job drafts. |
| 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. |
| GetDeploymentDraftLock | Obtain Edit Lock for Job Draft | Before using an API to edit, validate, or deploy a job draft, you must acquire an edit lock to prevent conflicts between user interface (UI) and API operations. Acquiring this lock requires either the "Develop SQL/YAML Job (Create, Edit)" or "Unlock SQL/YAML Job Draft" permission. |
Custom functions
|
API |
Title |
Description |
| CreateUdfArtifact | Create a custom function file | Parses the uploaded JAR or Python package, extracts all UDF methods, and creates a custom function file. |
| UpdateUdfArtifact | UpdateUdfArtifact | Updates the JAR file of the user-defined function (UDF) that you create. |
| GetUdfArtifacts | GetUdfArtifacts | Obtains the details of the JAR or Python file that corresponds to the user-defined function (UDF) that you upload and create. |
| 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. |
| DeleteUdfFunction | DeleteUdfFunction | Deletes an existing user-defined function (UDF) from a Realtime Compute for Apache Flink workspace. |
| 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. |
Custom connectors
|
API |
Title |
Description |
| ListCustomConnectors | List custom connectors | Lists the registered custom connectors. |
| RegisterCustomConnector | RegisterCustomConnector | Registers a custom connector in a namespace. The registered custom connector can be used in SQL statements. |
| DeleteCustomConnector | Delete a custom connector | Deletes a registered custom connector. |
Metadata
|
API |
Title |
Description |
| GetDatabases | Get database information | Retrieves information about a specified database or lists all databases under a specified catalog. |
| GetTables | Retrieve table information | Retrieves the details of a specific table or information about all tables under a specified database in a catalog. |
| GetCatalogs | Get catalog information | Retrieves the details of a specified catalog or all catalogs. |
| ExecuteSqlStatement | Execute metadata SQL statements | Runs metadata-related SQL statements. Only DDL and DML statements are supported. DQL statements are not supported. |
Deployed jobs
|
API |
Title |
Description |
| GetDeploymentsByName | GetDeploymentsByName | Retrieves deployed job instances by name from a specified workspace and namespace. |
| GetDeploymentsByLabel | GetDeploymentsByLabel | Queries a list of deployed jobs and their information by a specified label. |
| GetDeploymentsByIp | GetDeploymentsByIp | Gets a list of deployed jobs and their information on a node by a specified IP address. |
| CreateDeployment | Create a deployed job | Creates a deployed job. |
| UpdateDeployment | Update a deployed job | Updates the information of a deployed job. |
| UpdateDeploymentByName | Update a deployment job by name | Updates the details and configuration parameters of a deployment job by its name. |
| GetDeployment | GetDeployment | Obtains the details of a deployment. |
| ListDeployments | List deployed jobs | Retrieves information about all deployed jobs. |
| DeleteDeployment | Delete a deployed job | Deletes a deployed job by job ID. |
| DeleteDeploymentByName | Delete a deployed job by name | Deletes the deployment instance information of a job in a specified workspace and namespace based on the deployed job name. |
| GetEvents | Retrieve run events | Retrieves run events. |
Job deployment targets
|
API |
Title |
Description |
| CreateDeploymentTargetV2 | Create a deployment target (V2) | Creates a deployment target. |
| UpdateDeploymentTargetV2 | Update a deployment target (V2) | Updates a deployment target. |
| CreateDeploymentTarget | Create a deployment target | Creates a deployment target. |
| UpdateDeploymentTarget | Update Deployment Target | Updates a deployment target. |
| DeleteDeploymentTarget | Delete Deployment Target | Deletes a deployment target. |
| 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. |
Job instances
|
API |
Title |
Description |
| GetJob | Retrieve a job instance | Retrieves the details of a job instance. |
| ListJobs | List job instances | Retrieves information about all job instances of a deployed job. |
| StartJobWithParams | Start a job instance | Starts a job instance. |
| StopJob | Stop a job instance | Stops a job instance. |
| DeleteJob | DeleteJob | Deletes the information about a job that is not in the running state in a deployment. |
| HotUpdateJob | HotUpdateJob | Dynamically updates parameters or resources of a deployment that is running. |
| GetHotUpdateJobResult | Obtain the Result of a Dynamic Job Update | Retrieves the result of a hot update for a job. |
| GetLatestJobStartLog | GetLatestJobStartLog | Obtains the latest startup logs of a job. |
| GetJobDiagnosis | Retrieve job diagnostics details | Performs intelligent diagnostics on a job and retrieves information about abnormal diagnostic items. |
| StartJob | Start job instance (deprecated) | Creates and starts a job instance. |
Snapshots
|
API |
Title |
Description |
| CreateSavepoint | Create a snapshot | Creates a snapshot. |
| GetSavepoint | GetSavepoint | Queries details of a savepoint and checkpoint. |
| DeleteSavepoint | DeleteSavepoint | Deletes a savepoint. |
| ListSavepoints | ListSavepoints | Obtains a list of savepoints or checkpoints. |
Data lineage
|
API |
Title |
Description |
| GetLineageInfo | GetLineageInfo | Obtains the lineage information of a deployment. |
Schedules
|
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 | Apply scheduled plan | Executes 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 plan execution history | Retrieves the execution history of scheduled plans. |
Autotuning plans
|
API |
Title |
Description |
| UpdateAutopilotPolicy | Update automatic tuning configuration | Updates an Autopilot tuning policy. |
| ListAutopilotTuningHistories | Query tuning history | Retrieves the Autopilot tuning history records. |
| GetAutopilotPolicy | Query autopilot tuning configuration | Retrieves the Autopilot tuning configuration. |
Session clusters
|
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. |
Data query
|
API |
Title |
Description |
| StartSqlExecution | Execute SQL data query script | Executes an SQL data query script task. |
| StopSqlExecution | Stop an SQL query script | Executes an SQL query script task. |
| FetchSqlExecutionResult | Get SQL query execution result | Retrieves the execution result of an SQL data query submitted through the platform. |
| CreateSqlFile | Create a query script | Creates a SQL query script job file. |
| GetSqlFile | Get query script | Retrieves the details of a created SQL query script. |
| DeleteSqlFile | Delete a query script | Deletes a created SQL query script file. |
| UpdateSqlFile | Get query script | Updates a created SQL query script. |
Variable management
|
API |
Title |
Description |
| UpdateVariable | UpdateVariable | Updates the information about a variable in a namespace. |
| CreateVariable | Create a variable | Creates a variable. |
| DeleteVariable | DeleteVariable | Deletes a variable. |
| ListVariables | ListVariables | Obtains a list of variables. |
Member management
|
API |
Title |
Description |
| CreateMember | Authorize a member | Adds a user to the specified workspace and grants the corresponding permissions. |
| UpdateMember | UpdateMember | Updates the permissions of one or more members in a specific namespace. |
| DeleteMember | DeleteMember | Revokes the permissions from a member. |
| GetMember | GetMember | Queries the permissions of a member. |
| ListMembers | ListMembers | Queries the mappings between the ID and permissions of a member in a specific namespace. |
Intelligent inspection
|
API |
Title |
Description |
| ListPatrolReports | List inspection reports | Queries a list of inspection reports. |
| GetPatrolReportDetail | Retrieve inspection report details | Retrieves the details of an inspection report. |
| GetPatrolConfig | Retrieve inspection configuration | Retrieves the inspection configuration. |
| TriggerPatrol | Trigger an inspection | Triggers an inspection. |
| UpdatePatrolConfig | Update inspection configuration | Updates the inspection configuration. |
Intelligent assistant
|
API |
Title |
Description |
| ChatAiAgent | Initiate AI assistant conversation | Initiates a streaming conversation with an AI agent. |
Other
|
API |
Title |
Description |
| ListEngineVersionMetadata | ListEngineVersionMetadata | Obtains a list of engine versions that are supported by Realtime Compute for Apache Flink. |
| 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. |
| GetGenerateResourcePlanResult | GetGenerateResourcePlanResult | Obtains the asynchronous generation result of fine-grained resources based on the ID of the ticket that applies for an asynchronous generation. |
| FlinkApiProxy | FlinkApiProxy | Provides a proxy for Realtime Compute for Apache Flink requests. |