Jump to

• Request
• Response

Get workspace details

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}

Gets detailed information about an AI Data Platform Workbench workspace.

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

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

The AI Data Platform Workbench workspace details are 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.

Body ()

Root Schema : Workspace

Type: object

A AI Data Platform Workbench Workspace is a logical container that provides users with a collaborative development and runtime environment. Workspace organizes and manages resources such as compute clusters, motebooks, and data orchestration workflows. Workspace provides shared file system areas to allow for storage of notebooks, SQL scripts, and other files. Collaboration features such as version control integration (e.g. GitHub) as well as CI/CD tools integration. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see IAM Policies for Oracle AI Data Platform Workbench.

Show Source

• aicUserSchemaName: string
  The name of the AIC user schema if created.
• createdBy: string
  OCID of the user who created this record.
• createdByName: string
  Name of the user who created this record.
• defaultCatalogKey: string
  The key of the catalog to be used as the default catalog for this workspace. A default catalog in the workspace will allow users to use that catalog without the need to refer it in the notebook. For example, if default catalog is iCat1, and it has schema1 and table1, you can refer to the table in a notebook using: schema1.table1.
• description: string
  Description of the workspace.
• displayName(required): string
  A user-friendly name that has to be unique in a AI Data Platform Workbench instance.
• isPrivateNetworkEnabled: boolean
  A flag to display whether workspace is private network enabled or not.
• key(required): string
  The key of the AI Data Platform Workbench workspace.
• lifecycleDetails: string
  A message that describes the current state of the workspace in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
• lifecycleState(required): string
  Allowed Values: [ "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED" ]

  The current state of the AI Data Platform Workbench workspace.
• logGroupId: string
  The OCID of the log group that contains the logs. This uniquely identifies a collection of logs within OCI Logging Service.

  Example: ocid1.loggroup.oc1.iad.aaaaaaaaxxxxxx
• networkConfigurationDetails: object WorkspaceNetworkConfigurationDetails
  Private network configuration details.
• systemTags: object systemTags
  Additional Properties Allowed: additionalProperties

  System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
• timeCreated(required): string(date-time)
  The date and time the AI Data Platform Workbench workspace was created, in the format defined by RFC 3339. Example: `2016-08-25T21:10:29.600Z`
• timeUpdated: string(date-time)
  The date and time the AI Data Platform Workbench workspace was updated, in the format defined by RFC 3339. Example: `2016-08-25T21:10:29.600Z`
• type: string
  Allowed Values: [ "DEFAULT", "USER" ]

  Workspace type. Type is DEFAULT for workspace created at AI Data Platform Workbench creation, type is USER for workspace created by AI Data Platform Workbench user.
• updatedBy: string
  OCID of the user who updated this record.
• updatedByName: string
  Name of the user who updated this record.

{
    "description":"A AI Data Platform Workbench Workspace is a logical container that provides users with a collaborative development and runtime environment.\nWorkspace organizes and manages resources such as compute clusters, motebooks, and data orchestration workflows. \nWorkspace provides shared file system areas to allow for storage of notebooks, SQL scripts, and other files. \nCollaboration features such as version control integration (e.g. GitHub) as well as CI/CD tools integration.\nTo use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to\nan administrator. If you're an administrator who needs to write policies to give users access, see \n<a href=\"https://docs.oracle.com/en/cloud/paas/ai-data-platform/aidug/iam-policies-oracle-ai-data-platform.html\" target=\"_blank\" rel=\"noopener noreferrer\">IAM Policies for Oracle AI Data Platform Workbench</a>.\n",
    "type":"object",
    "required":[
        "key",
        "lifecycleState",
        "timeCreated",
        "displayName"
    ],
    "properties":{
        "key":{
            "description":"The key of the AI Data Platform Workbench workspace.",
            "type":"string"
        },
        "displayName":{
            "description":"A user-friendly name that has to be unique in a AI Data Platform Workbench instance.",
            "type":"string"
        },
        "description":{
            "description":"Description of the workspace.",
            "type":"string"
        },
        "type":{
            "description":"Workspace type. Type is DEFAULT for workspace created at AI Data Platform Workbench creation, type is USER for workspace created by AI Data Platform Workbench user.",
            "type":"string",
            "enum":[
                "DEFAULT",
                "USER"
            ]
        },
        "timeCreated":{
            "description":"The date and time the AI Data Platform Workbench workspace was created, in the format defined by <a href=\"https://tools.ietf.org/html/rfc3339\" target=\"_blank\" rel=\"noopener noreferrer\">RFC 3339</a>.\nExample: `2016-08-25T21:10:29.600Z`\n",
            "type":"string",
            "format":"date-time"
        },
        "timeUpdated":{
            "description":"The date and time the AI Data Platform Workbench workspace was updated, in the format defined by <a href=\"https://tools.ietf.org/html/rfc3339\" target=\"_blank\" rel=\"noopener noreferrer\">RFC 3339</a>.\nExample: `2016-08-25T21:10:29.600Z`\n",
            "type":"string",
            "format":"date-time"
        },
        "lifecycleState":{
            "description":"The current state of the AI Data Platform Workbench workspace.",
            "type":"string",
            "enum":[
                "CREATING",
                "UPDATING",
                "ACTIVE",
                "DELETING",
                "DELETED",
                "FAILED"
            ]
        },
        "lifecycleDetails":{
            "description":"A message that describes the current state of the workspace in more detail. For example,\ncan be used to provide actionable information for a resource in the Failed state.\n",
            "type":"string"
        },
        "systemTags":{
            "description":"System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only the String type is supported.\n"
                }
            }
        },
        "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"
        },
        "defaultCatalogKey":{
            "description":"The key of the catalog to be used as the default catalog for this workspace.\nA default catalog in the workspace will allow users to use that\ncatalog without the need to refer it in the notebook. For example, if default catalog is iCat1, and it has\nschema1 and table1, you can refer to the table in a notebook using: schema1.table1.\n",
            "type":"string"
        },
        "isPrivateNetworkEnabled":{
            "type":"boolean",
            "description":"A flag to display whether workspace is private network enabled or not."
        },
        "networkConfigurationDetails":{
            "$ref":"#/definitions/WorkspaceNetworkConfigurationDetails"
        },
        "logGroupId":{
            "type":"string",
            "description":"The OCID of the log group that contains the logs.\nThis uniquely identifies a collection of logs within OCI Logging Service.\n",
            "example":"ocid1.loggroup.oc1.iad.aaaaaaaaxxxxxx"
        },
        "aicUserSchemaName":{
            "type":"string",
            "description":"The name of the AIC user schema if created."
        }
    }
}

Nested Schema : WorkspaceNetworkConfigurationDetails

Type: object

Private network configuration details.

Show Source

• nsgIds: array nsgIds
  An array of network security group OCIDs.
• scanDetails: array scanDetails
  Maximum Number of Items: 15

  An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value. [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]
• subnetId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of a subnet.

{
    "description":"Private network configuration details.",
    "type":"object",
    "properties":{
        "subnetId":{
            "type":"string",
            "description":"The OCID of a subnet.\n",
            "minLength":1,
            "maxLength":255
        },
        "nsgIds":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"An array of network security group OCIDs.\n",
            "minLength":1,
            "maxLength":255
        },
        "scanDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Scan"
            },
            "maxItems":15,
            "description":"An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value.\n[ { fqdn: \"scan1.oracle.com\", port: \"1521\"}, { fqdn: \"scan2.oracle.com\", port: \"1521\" } ]\n"
        }
    }
}

Nested Schema : systemTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}`

{
    "description":"System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only the String type is supported.\n"
        }
    }
}

System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

Nested Schema : nsgIds

Type: array

Minimum Length: 1

Maximum Length: 255

An array of network security group OCIDs.

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"An array of network security group OCIDs.\n",
    "minLength":1,
    "maxLength":255
}

Nested Schema : scanDetails

Type: array

Maximum Number of Items: 15

An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value. [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]

Show Source

• Array of: object Scan
  Single Client Access Name (SCAN) is the object with a fully-qualified domain name and a port number.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Scan"
    },
    "maxItems":15,
    "description":"An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value.\n[ { fqdn: \"scan1.oracle.com\", port: \"1521\"}, { fqdn: \"scan2.oracle.com\", port: \"1521\" } ]\n"
}

Nested Schema : Scan

Type: object

Single Client Access Name (SCAN) is the object with a fully-qualified domain name and a port number.

Show Source

• fqdn: string
  A fully-qualified domain name (FQDN).
• port: string
  Port number of the FQDN.

{
    "type":"object",
    "description":"Single Client Access Name (SCAN) is the object with a fully-qualified domain name and a port number.",
    "properties":{
        "fqdn":{
            "description":"A fully-qualified domain name (FQDN).",
            "type":"string"
        },
        "port":{
            "description":"Port number of the FQDN.",
            "type":"string"
        }
    }
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the String type is supported.

{
    "type":"object",
    "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only the String type is supported.\n"
    }
}

Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

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.

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

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