LakeSail PlatformPREVIEW

Appearance

The managed Apache Flink service on the LakeSail platform is deprecated.

LakeSail is building Sail, an open-source computation framework in Rust to seamlessly integrate stream-processing, batch-processing, and compute-intensive (AI) workloads. The LakeSail platform will offer the managed solution for Sail. Existing PySpark and Flink SQL workloads can be migrated with ease. Please stay tuned and contact us if you are interested!

LakeSail API ​

LakeSail exposes REST API for all its operations. You can make API requests using any HTTP client, such as the curl command, or libraries in your favorite programming language.

Endpoints ​

The API is accessible at the path prefix /api of the LakeSail server. The operations are grouped by the path as follows.

  • /api/admin/v1 (Administrative Operations)

    These are operations for managing the LakeSail server. The access to these operations is restricted to server administrators.

  • /api/org/v1 (Organization Operations)

    These are operations for managing organization resources. The organization of interest is inferred from the bearer token in the Authorization header of the HTTP request.

  • /api/flink/v1 (Flink Operations)

    These are operations for managing Flink resources. The organization of interest are inferred from the bearer token in the Authorization header of the HTTP request.

Each path may allow multiple HTTP methods such as GET, POST, PATCH, and DELETE, to perform creation, retrieval, update, and deletion of resources.

Data Format ​

The API expects the request body in JSON format with UTF-8 encoding, and returns the response in JSON format with UTF-8 encoding. So you can specify the following HTTP headers in your request.

http
Content-Type: application/json
Accept: application/json

You can expect the following HTTP header in the response.

http
Content-Type: application/json; charset=utf-8

The API uses HTTP status codes to indicate the result of the operation. On a successful operation, the API returns a 2xx status code. The response body is either a JSON object (with an operation-dependent schema), or empty if the operation does not return any data (e.g. a DELETE request). On a failed operation, the API returns a 4xx or 5xx status code. The response body is a JSON object of the Error schema.

Further Reading ​

Please refer to Authentication for information about authenticating API requests. Please refer to Pagination for information about how pagination works in list operations.

Reference ​

Please refer to the API Reference for the detailed API specification.