Jump to

• Request
• Response

Get available sessions

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/notebook/api/sessions

Returns a list of all available sessions.

Request

Path Parameters

• aiDataPlatformId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
• workspaceKey(required): string
  The key of the Workspace

Query Parameters

• agentFlowKey: string
  Agent flow key of the attached agent flow.
• cluster_id: string
  Cluster ID attached to a session.
• path: string
  Notebook file path attached to a session.

Header Parameters

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. List of available sessions is retrieved.

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : SessionCollection

Type: object

A list of session summaries related to a workspace.

Show Source

• items(required): array items
  List of sessions.

{
    "type":"object",
    "description":"A list of session summaries related to a workspace.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of sessions.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/SessionSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

List of sessions.

Show Source

• Array of: object SessionSummary
  Summary information about a notebook session.

{
    "description":"List of sessions.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/SessionSummary"
    }
}

Nested Schema : SessionSummary

Type: object

Summary information about a notebook session.

Show Source

• agentFlowKey: string
  Agent flow key of an agent flow.
• cluster_id: string
  Cluster ID.
• id: string
  UUID if the session.
• kernel: object KernelSummary
  Kernel summary
• lifecycleState: string
  lifecycleState of a Notebook Session.
• name: string
  A user-friendly name for the session.
• path: string
  Path to the session. A directory where notebook server is started and where notebooks are saved. For example, /data/test.ipynb.
• type: string
  Type of session.

{
    "description":"Summary information about a notebook session.",
    "type":"object",
    "properties":{
        "id":{
            "description":"UUID if the session.",
            "type":"string"
        },
        "name":{
            "description":"A user-friendly name for the session.",
            "type":"string"
        },
        "path":{
            "description":"Path to the session. A directory where notebook server is started and where notebooks are saved. For example, /data/test.ipynb.",
            "type":"string"
        },
        "type":{
            "description":"Type of session.",
            "type":"string",
            "x-obmcs-enumref":"#/definitions/Session/type"
        },
        "cluster_id":{
            "type":"string",
            "description":"Cluster ID."
        },
        "kernel":{
            "$ref":"#/definitions/KernelSummary"
        },
        "agentFlowKey":{
            "type":"string",
            "description":"Agent flow key of an agent flow."
        },
        "lifecycleState":{
            "type":"string",
            "description":"lifecycleState of a Notebook Session.",
            "x-obmcs-enumref":"#/definitions/Session/lifecycleState"
        }
    }
}

Nested Schema : KernelSummary

Type: object

Kernel summary

Show Source

• connections: integer
  The number of active connections to this kernel.
• execution_state: string
  Current execution state of the kernel. Typically 'idle' or 'busy', but may be other values, such as 'starting'.
• id: string
  UUID of the kernel.
• last_activity: string
  ISO 8601 timestamp for the last-seen activity on this kernel. Use this in combination with execution_state == 'idle' to identify which kernels have been idle since a given time. Timestamps will be UTC, indicated 'Z' suffix. Added in notebook server 5.0.
• name(required): string
  Kernel spec name.

{
    "description":"Kernel summary",
    "required":[
        "name"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"UUID of the kernel."
        },
        "name":{
            "type":"string",
            "description":"Kernel spec name."
        },
        "last_activity":{
            "type":"string",
            "description":"ISO 8601 timestamp for the last-seen activity on this kernel.\nUse this in combination with execution_state == 'idle' to identify\nwhich kernels have been idle since a given time.\nTimestamps will be UTC, indicated 'Z' suffix.\nAdded in notebook server 5.0.\n"
        },
        "connections":{
            "type":"integer",
            "description":"The number of active connections to this kernel.\n"
        },
        "execution_state":{
            "type":"string",
            "description":"Current execution state of the kernel. Typically 'idle' or 'busy', but may be other values, such as 'starting'.\n"
        }
    }
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested resource was not found.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests. Too many requests sent to the server in a short period.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Default Response

Unknown Error. Error is not recognized by the system.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Back to Top