API docs by Redocly

Flink Compute Service (v1alpha1)

Download OpenAPI specification:Download

Andriy Kornatskyy: andriy.kornatskyy@live.com License: MIT

REST API for the Flink Compute Service. This API runs Flink application on AWS EC2.

clusters

Provides operations for managing clusters.

Retrieves a list of clusters

Authorizations:
ApiKeyAuth
path Parameters
namespace
required
string
Example: default

Responses

Response samples

Content type
application/json
{
  • "clusters": [
    ]
}

Create a cluster

Authorizations:
ApiKeyAuth
path Parameters
namespace
required
string
Example: default
Request Body schema: application/json
required
id
string
object
imageId
string
entrypoint
required
string
sourceUrl
required
string
lifetimeSeconds
required
number
required
object
object
tags
object

Responses

Request samples

Content type
application/json
Example
{
  • "imageFilter": {
    },
  • "entrypoint": "org.apache.flink.streaming.examples.wordcount.WordCount",
  • "sourceUrl": "https://...s3.eu-central-1.amazonaws.com/WordCount.jar?...",
  • "lifetimeSeconds": 90,
  • "jobManager": {
    },
  • "tags": {
    }
}

Response samples

Content type
application/json
{
  • "id": "85d455dbe2"
}

Retrieves a list of cluster instances

Authorizations:
ApiKeyAuth
path Parameters
namespace
required
string
Example: default
id
required
string
Example: 85d455dbe2

Responses

Response samples

Content type
application/json
{
  • "instances": [
    ]
}

images

Provides operations for managing images.

Retrieves a list of images

Authorizations:
ApiKeyAuth
query Parameters
name
string
architecture
string
Enum: "arm64" "x86_64"

Responses

Response samples

Content type
application/json
{
  • "images": [
    ]
}

other

Provides other operations.

Queries health-related information

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "status": "UP"
}