REST API for Oracle AI Data Platform Workbench

200 Response

Successful operation. Master catalog default cluster information is retrieved.

Headers

etag: string

For optimistic concurrency control. See `if-match`.
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.

Root Schema : DefaultCluster

Type: object

The default cluster created by AI Data Platform Workbench.

Match All

The default cluster created by AI Data Platform Workbench.

Show Source

object Cluster

Discriminator: sourceApi

A Cluster is a compute subresource within AI Data Platform Workbench. Compute/Runtime Clusters are Spark execution environments. Spark clusters are used for Notebook execution and for Spark SQL query execution over JDBC/ODBC. These clusters seamlessly process the data in the AI Data Platform Workbench. Users can also use JDBC/ODBC endpoints for highly performant SQL execution for integration with analytics tools such as Oracle Analytic Cloud and Excel. A DEFAULT cluster is a subresource within AI Data Platform Workbench associated with master catalog and it can not be attached to a notebook. A USER cluster is a subresource within workspace and can be attached to a notebook.
object DefaultCluster-allOf[1]

Discriminator: DEFAULT_CLUSTER_API

{
    "type":"object",
    "description":"The default cluster created by AI Data Platform Workbench.",
    "allOf":[
        {
            "$ref":"#/definitions/Cluster"
        },
        {
            "discriminator":"DEFAULT_CLUSTER_API",
            "properties":{
                "workspaceKey":{
                    "type":"string",
                    "description":"The key of the AI Data Platform Workbench workspace where the default cluster is."
                },
                "workerConfig":{
                    "$ref":"#/definitions/WorkerConfig"
                },
                "clusterRuntimeConfig":{
                    "$ref":"#/definitions/ClusterRuntimeConfig"
                },
                "loggingConfig":{
                    "$ref":"#/definitions/LoggingConfig"
                },
                "autoTerminationMinutes":{
                    "type":"integer",
                    "format":"int32",
                    "default":null,
                    "x-default-description":"When no value is set, the cluster is not auto-stopped.",
                    "description":"Optional timeout value in minutes used to automatically stop idle compute clusters.",
                    "minimum":5,
                    "maximum":59940
                },
                "jdbcEndpointUrl":{
                    "description":"Spark JDBC URL.",
                    "type":"string"
                },
                "logId":{
                    "type":"string",
                    "description":"The OCID of the log where cluster logs are published and retrieved. This logId is always created within the logGroupId returned in the response payload.\n",
                    "example":"ocid1.log.oc1.phx.amaaaaaaeq37tyqau2j7ug7xnlhtwiubbinfhiuc2fatgwtzt3s3flivchma"
                },
                "logGroupId":{
                    "type":"string",
                    "description":"The unique OCID that identifies a specific log group within OCI Logging.\nThis log group is exclusively associated with the AI Data Platform Workbench instance and is created in the same compartment within the customer???s tenancy as the AI Data Platform Workbench instance.\n",
                    "example":"ocid1.loggroup.oc1.phx.amaaaaaaeq37tyqau3s5k4zp7gimmao3duxdy2y2j5x3lutjdhggjwzb7w3q"
                },
                "subscription":{
                    "$ref":"#/definitions/SubscriptionDetails"
                }
            }
        }
    ]
}

Nested Schema : Cluster

Type: object

Discriminator: sourceApi

A Cluster is a compute subresource within AI Data Platform Workbench. Compute/Runtime Clusters are Spark execution environments. Spark clusters are used for Notebook execution and for Spark SQL query execution over JDBC/ODBC. These clusters seamlessly process the data in the AI Data Platform Workbench. Users can also use JDBC/ODBC endpoints for highly performant SQL execution for integration with analytics tools such as Oracle Analytic Cloud and Excel. A DEFAULT cluster is a subresource within AI Data Platform Workbench associated with master catalog and it can not be attached to a notebook. A USER cluster is a subresource within workspace and can be attached to a notebook.

Show Source

activeClusterResources: object ActiveClusterResources

Active resources of a cluster.
createdBy: string

OCID of the user who created this record.
createdByName: string

Name of the user who created this record.
description: string

Minimum Length: 1

Maximum Length: 400

Cluster description.
displayName(required): string

Cluster name.
driverConfig: object DriverConfig

Driver configuration.
key(required): string

Cluster key.
nodeType: string

Minimum Length: 1

Maximum Length: 255

Cluster node type encodes the node shape and associated resources.
sourceApi: string

Default Value: CLUSTER_API

Allowed Values: [ "CLUSTER_API", "DEFAULT_CLUSTER_API", "AGENT_FLOW_COMPUTE" ]

User created clusters are associated with a particular workspace. Default cluster is to be used by all catalogs operations that require compute. Default cluster can be thought of as associated with Master catalog. Agent Flow Compute is used to execute Agent Flows.
state(required): string

Allowed Values: [ "ACCEPTED", "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "STOPPING", "STOPPED", "UPDATING", "RESTARTING", "STARTING", "NETWORK_CONFIGURATION_ATTACH_IN_PROGRESS", "NETWORK_CONFIGURATION_ATTACH_SUCCESSFUL", "NETWORK_CONFIGURATION_ATTACH_FAILED", "NETWORK_CONFIGURATION_DETACH_IN_PROGRESS", "NETWORK_CONFIGURATION_DETACH_SUCCESSFUL", "NETWORK_CONFIGURATION_DETACH_FAILED" ]

Common lifecycle states for resources in a compute cluster. ACCEPTED - The resource create request has been accepted. CREATING - The resource is being created and might not be usable until the entire metadata is defined. ACTIVE - The resource is valid and available for access. DELETING - The resource is being deleted, and might require a deep clean of any children. DELETED - The resource has been deleted, and isn't available. FAILED - The resource is in a failed state due to validation or other errors. STOPPING - The resource is being stopped. STOPPED - The resource has been stopped. UPDATING - The resource is being updated and might not be usable until all changes are commited. STARTING - The resource is being started. RESTARTING - The resource is being restarted.
stateDetails: string

A message that describes the current state of the workspace cluster in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
stoppedBy: string

OCID of the user who stopped the cluster. Value will be 'SYSTEM' if it was auto stopped.
stoppedByName: string

Name of the user who stopped the cluster. Value will be 'SYSTEM' if it was auto stopped.
timeCreated(required): string(date-time)

Date and time the cluster was created.
timeUpdated: string(date-time)

Date and time the cluster was updated.
type: string

Allowed Values: [ "USER", "AGENT_FLOW_COMPUTE" ]

ClusterType
updatedBy: string

OCID of the user who updated this record.
updatedByName: string

Name of the user who updated this record.

{
    "description":"A Cluster is a compute subresource within AI Data Platform Workbench. Compute/Runtime Clusters are Spark execution environments. \nSpark clusters are used for Notebook execution and for Spark SQL query execution over JDBC/ODBC. \nThese clusters seamlessly process the data in the AI Data Platform Workbench.  Users can also use JDBC/ODBC endpoints for highly \nperformant SQL execution for integration with analytics tools such as Oracle Analytic Cloud and Excel.\nA DEFAULT cluster is a subresource within AI Data Platform Workbench associated with master catalog and it can not be\nattached to a notebook. A USER cluster is a subresource within workspace and can be attached to a notebook.\n",
    "type":"object",
    "required":[
        "key",
        "state",
        "timeCreated",
        "displayName"
    ],
    "discriminator":"sourceApi",
    "properties":{
        "key":{
            "description":"Cluster key.",
            "type":"string"
        },
        "displayName":{
            "description":"Cluster name.",
            "type":"string"
        },
        "description":{
            "description":"Cluster description.",
            "type":"string",
            "minLength":1,
            "maxLength":400
        },
        "sourceApi":{
            "description":"User created clusters are associated with a particular workspace. Default cluster is to\nbe used by all catalogs operations that require compute. Default cluster can be thought of as\nassociated with Master catalog. Agent Flow Compute is used to execute Agent Flows.\n",
            "type":"string",
            "default":"CLUSTER_API",
            "enum":[
                "CLUSTER_API",
                "DEFAULT_CLUSTER_API",
                "AGENT_FLOW_COMPUTE"
            ]
        },
        "type":{
            "type":"string",
            "description":"ClusterType",
            "x-obmcs-top-level-enum":"#/definitions/ClusterType",
            "enum":[
                "USER",
                "AGENT_FLOW_COMPUTE"
            ]
        },
        "timeCreated":{
            "description":"Date and time the cluster was created.",
            "type":"string",
            "format":"date-time"
        },
        "timeUpdated":{
            "description":"Date and time the cluster was updated.",
            "type":"string",
            "format":"date-time"
        },
        "state":{
            "description":"Common lifecycle states for resources in a compute cluster.\nACCEPTED        - The resource create request has been accepted.\nCREATING        - The resource is being created and might not be usable until the entire metadata is defined.\nACTIVE          - The resource is valid and available for access.\nDELETING        - The resource is being deleted, and might require a deep clean of any children.\nDELETED         - The resource has been deleted, and isn't available.\nFAILED          - The resource is in a failed state due to validation or other errors.\nSTOPPING        - The resource is being stopped.\nSTOPPED         - The resource has been stopped.\nUPDATING        - The resource is being updated and might not be usable until all changes are commited.\nSTARTING        - The resource is being started.\nRESTARTING      - The resource is being restarted.\n",
            "type":"string",
            "enum":[
                "ACCEPTED",
                "CREATING",
                "ACTIVE",
                "DELETING",
                "DELETED",
                "FAILED",
                "STOPPING",
                "STOPPED",
                "UPDATING",
                "RESTARTING",
                "STARTING",
                "NETWORK_CONFIGURATION_ATTACH_IN_PROGRESS",
                "NETWORK_CONFIGURATION_ATTACH_SUCCESSFUL",
                "NETWORK_CONFIGURATION_ATTACH_FAILED",
                "NETWORK_CONFIGURATION_DETACH_IN_PROGRESS",
                "NETWORK_CONFIGURATION_DETACH_SUCCESSFUL",
                "NETWORK_CONFIGURATION_DETACH_FAILED"
            ]
        },
        "stateDetails":{
            "description":"A message that describes the current state of the workspace cluster in more detail. For example, can be used to provide actionable information for a resource in the Failed state.",
            "type":"string"
        },
        "nodeType":{
            "description":"Cluster node type encodes the node shape and associated resources.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "driverConfig":{
            "$ref":"#/definitions/DriverConfig"
        },
        "activeClusterResources":{
            "$ref":"#/definitions/ActiveClusterResources"
        },
        "createdBy":{
            "description":"OCID of the user who created this record.",
            "type":"string"
        },
        "createdByName":{
            "description":"Name of the user who created this record.",
            "type":"string"
        },
        "updatedBy":{
            "description":"OCID of the user who updated this record.",
            "type":"string"
        },
        "updatedByName":{
            "description":"Name of the user who updated this record.",
            "type":"string"
        },
        "stoppedBy":{
            "description":"OCID of the user who stopped the cluster. Value will be 'SYSTEM' if it was auto stopped.",
            "type":"string"
        },
        "stoppedByName":{
            "description":"Name of the user who stopped the cluster. Value will be 'SYSTEM' if it was auto stopped.",
            "type":"string"
        }
    }
}

Nested Schema : DefaultCluster-allOf[1]

Type: object

Discriminator: DEFAULT_CLUSTER_API

Show Source

autoTerminationMinutes: integer(int32)

Minimum Value: 5

Maximum Value: 59940

Default Value: oracle.doceng.json.BetterJsonNull@6719a5b8

Optional timeout value in minutes used to automatically stop idle compute clusters.
clusterRuntimeConfig: object ClusterRuntimeConfig

Discriminator: type

Cluster runtime configurations.
jdbcEndpointUrl: string

Spark JDBC URL.
loggingConfig: object LoggingConfig

Discriminator: type

Logging configuration.
logGroupId: string

The unique OCID that identifies a specific log group within OCI Logging. This log group is exclusively associated with the AI Data Platform Workbench instance and is created in the same compartment within the customer???s tenancy as the AI Data Platform Workbench instance.

Example: ocid1.loggroup.oc1.phx.amaaaaaaeq37tyqau3s5k4zp7gimmao3duxdy2y2j5x3lutjdhggjwzb7w3q
logId: string

The OCID of the log where cluster logs are published and retrieved. This logId is always created within the logGroupId returned in the response payload.

Example: ocid1.log.oc1.phx.amaaaaaaeq37tyqau2j7ug7xnlhtwiubbinfhiuc2fatgwtzt3s3flivchma
subscription: object SubscriptionDetails

Details of subscription.
workerConfig: object WorkerConfig

Worker configuration.
workspaceKey: string

The key of the AI Data Platform Workbench workspace where the default cluster is.

{
    "discriminator":"DEFAULT_CLUSTER_API",
    "properties":{
        "workspaceKey":{
            "type":"string",
            "description":"The key of the AI Data Platform Workbench workspace where the default cluster is."
        },
        "workerConfig":{
            "$ref":"#/definitions/WorkerConfig"
        },
        "clusterRuntimeConfig":{
            "$ref":"#/definitions/ClusterRuntimeConfig"
        },
        "loggingConfig":{
            "$ref":"#/definitions/LoggingConfig"
        },
        "autoTerminationMinutes":{
            "type":"integer",
            "format":"int32",
            "default":null,
            "x-default-description":"When no value is set, the cluster is not auto-stopped.",
            "description":"Optional timeout value in minutes used to automatically stop idle compute clusters.",
            "minimum":5,
            "maximum":59940
        },
        "jdbcEndpointUrl":{
            "description":"Spark JDBC URL.",
            "type":"string"
        },
        "logId":{
            "type":"string",
            "description":"The OCID of the log where cluster logs are published and retrieved. This logId is always created within the logGroupId returned in the response payload.\n",
            "example":"ocid1.log.oc1.phx.amaaaaaaeq37tyqau2j7ug7xnlhtwiubbinfhiuc2fatgwtzt3s3flivchma"
        },
        "logGroupId":{
            "type":"string",
            "description":"The unique OCID that identifies a specific log group within OCI Logging.\nThis log group is exclusively associated with the AI Data Platform Workbench instance and is created in the same compartment within the customer???s tenancy as the AI Data Platform Workbench instance.\n",
            "example":"ocid1.loggroup.oc1.phx.amaaaaaaeq37tyqau3s5k4zp7gimmao3duxdy2y2j5x3lutjdhggjwzb7w3q"
        },
        "subscription":{
            "$ref":"#/definitions/SubscriptionDetails"
        }
    }
}

400 Response

Bad Request (invalid query parameters, malformed headers, 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.

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"
        }
    }
}

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.

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.

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.

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.

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.

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"
        }
    }
}