Jump to

• Request
• Response

Get selectable Compute configuration

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/clusters/{clusterKey}/actions/getComputeConfiguration

Gets cluster-scoped Python and JAR libraries and environment variables from Spark Compute.

Request

Path Parameters

• aiDataPlatformId(required): string
  Minimum Length: 1

  Maximum Length: 500

  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
• clusterKey(required): string
  Minimum Length: 1

  Maximum Length: 200

  Cluster key.
• workspaceKey(required): string
  Minimum Length: 1

  Maximum Length: 200

  The key of the Workspace

Header Parameters

• opc-request-id: string
  Maximum Length: 255

  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

Compute configuration retrieved.

Headers

• 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 : ComputeConfiguration

Type: object

Selectable Spark Compute configuration returned by Compute.

Show Source

• clusterKey: string
  Minimum Length: 1

  Maximum Length: 200

  Source cluster key.
• environmentVariables: object environmentVariables
  Additional Properties Allowed: additionalProperties

  Environment-variable keys and authoritative values configured on the source Compute.
• libraries: object ComputeConfigurationLibraries
  Cluster-scoped libraries configured on Spark Compute.

{
    "type":"object",
    "description":"Selectable Spark Compute configuration returned by Compute.",
    "properties":{
        "clusterKey":{
            "type":"string",
            "description":"Source cluster key.",
            "minLength":1,
            "maxLength":200
        },
        "environmentVariables":{
            "type":"object",
            "description":"Environment-variable keys and authoritative values configured on the source Compute.",
            "additionalProperties":{
                "type":"string"
            }
        },
        "libraries":{
            "$ref":"#/definitions/ComputeConfigurationLibraries"
        }
    }
}

Nested Schema : environmentVariables

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"Environment-variable keys and authoritative values configured on the source Compute.",
    "additionalProperties":{
        "type":"string"
    }
}

Environment-variable keys and authoritative values configured on the source Compute.

Nested Schema : ComputeConfigurationLibraries

Type: object

Cluster-scoped libraries configured on Spark Compute.

Show Source

• jars: array jars
  Unique Items Required: true

  JAR coordinates and workspace or volume paths.
• python: array python
  Unique Items Required: true

  Python package identifiers and workspace or volume paths.

{
    "type":"object",
    "description":"Cluster-scoped libraries configured on Spark Compute.",
    "properties":{
        "python":{
            "type":"array",
            "description":"Python package identifiers and workspace or volume paths.",
            "uniqueItems":true,
            "items":{
                "type":"string",
                "minLength":1,
                "maxLength":2048
            }
        },
        "jars":{
            "type":"array",
            "description":"JAR coordinates and workspace or volume paths.",
            "uniqueItems":true,
            "items":{
                "type":"string",
                "minLength":1,
                "maxLength":2048
            }
        }
    }
}

Nested Schema : jars

Type: array

Unique Items Required: true

JAR coordinates and workspace or volume paths.

Show Source

• Array of: string
  Minimum Length: 1

  Maximum Length: 2048

{
    "type":"array",
    "description":"JAR coordinates and workspace or volume paths.",
    "uniqueItems":true,
    "items":{
        "type":"string",
        "minLength":1,
        "maxLength":2048
    }
}

Nested Schema : python

Type: array

Unique Items Required: true

Python package identifiers and workspace or volume paths.

Show Source

• Array of: string
  Minimum Length: 1

  Maximum Length: 2048

{
    "type":"array",
    "description":"Python package identifiers and workspace or volume paths.",
    "uniqueItems":true,
    "items":{
        "type":"string",
        "minLength":1,
        "maxLength":2048
    }
}

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

409 Response

Conflict. Request conflicts with the current state of the resource.

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