ListFlinkSessions

Lists Flink sessions.

get/api/flink/v1/workspaces/{ws}/sessions

Path Parameters

• ws ^required

  A workspace ID.

  • Schema ResourceId
  • Type string
  • Minimum Length 1
  • Maximum Length 20
  • Pattern ^[A-Z0-9]+$

Query Parameters

• limit ^optional

  The maximum number of items to list.

  • Type integer
  • Format int32
  • Maximum 100 (inclusive)

• marker ^optional

  The pagination token returned from the previous list operation.

  • Type string

Request Body

This operation does not have a request body.

Responses

200 Response

A list of Flink sessions is returned.

• Schema FlinkSessionList
• Type object
• Properties

  • items ^required

    A list of Flink sessions.

    • Type array
    • Items

      A summary of a Flink session.

      • Schema FlinkSessionSummary

  • marker ^optional

    The pagination token to request more items.

    • Type string

400 Response

The requested operation cannot be performed because the request is malformed.

• Schema Error
• Type object
• Properties

  • message ^required

    An error message.

    • Type string

401 Response

The requested operation cannot be performed because the request lacks valid authentication credentials.

• Schema Error
• Type object
• Properties

  • message ^required

    An error message.

    • Type string

403 Response

The identity is not allowed to perform the requested operation for the resource involved.

• Schema Error
• Type object
• Properties

  • message ^required

    An error message.

    • Type string

404 Response

The resource or dependent resources involved in the requested operation do not exist.

• Schema Error
• Type object
• Properties

  • message ^required

    An error message.

    • Type string

Default Response

The requested operation failed with an error.

• Schema Error
• Type object
• Properties

  • message ^required

    An error message.

    • Type string