Jump to

• Request
• Response

Export selected Compute configuration

post

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

Writes selected Compute configuration values supplied by the caller to a workspace YAML file without overwriting an existing file.

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.
• opc-retry-token: string
  Maximum Length: 64

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might be rejected.

Body ()

Selected identifiers and destination for the YAML export.

Root Schema : ExportComputeConfigurationDetails

Type: object

Customer-selected Compute configuration values and YAML destination.

Show Source

• clusterScopedLibraries: array clusterScopedLibraries
  Unique Items Required: true

  Selected cluster-scoped library entries. Each entry must set exactly one of path, pip, or jar.
• destinationPath: string
  Minimum Length: 1

  Maximum Length: 1024

  Destination folder. Use /Workspace/... for a workspace file or /Volumes////... for a volume file. Defaults to /Workspace/configurations/.
• environmentVariables: object environmentVariables
  Additional Properties Allowed: additionalProperties

  Selected environment-variable keys and values to write to the YAML file.
• fileName: string
  Minimum Length: 1

  Maximum Length: 255

  Optional YAML filename. API-handler appends .yaml when omitted.

{
    "type":"object",
    "description":"Customer-selected Compute configuration values and YAML destination.",
    "properties":{
        "destinationPath":{
            "type":"string",
            "description":"Destination folder. Use /Workspace/... for a workspace file or /Volumes/<catalog>/<schema>/<volume>/... for a volume file. Defaults to /Workspace/configurations/.",
            "minLength":1,
            "maxLength":1024
        },
        "fileName":{
            "type":"string",
            "description":"Optional YAML filename. API-handler appends .yaml when omitted.",
            "minLength":1,
            "maxLength":255
        },
        "clusterScopedLibraries":{
            "type":"array",
            "description":"Selected cluster-scoped library entries. Each entry must set exactly one of path, pip, or jar.",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ComputeConfigurationLibraryEntry"
            }
        },
        "environmentVariables":{
            "type":"object",
            "description":"Selected environment-variable keys and values to write to the YAML file.",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : clusterScopedLibraries

Type: array

Unique Items Required: true

Selected cluster-scoped library entries. Each entry must set exactly one of path, pip, or jar.

Show Source

• Array of: object ComputeConfigurationLibraryEntry
  A cluster-scoped library entry in the Compute configuration YAML.

{
    "type":"array",
    "description":"Selected cluster-scoped library entries. Each entry must set exactly one of path, pip, or jar.",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ComputeConfigurationLibraryEntry"
    }
}

Nested Schema : environmentVariables

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"Selected environment-variable keys and values to write to the YAML file.",
    "additionalProperties":{
        "type":"string"
    }
}

Selected environment-variable keys and values to write to the YAML file.

Nested Schema : ComputeConfigurationLibraryEntry

Type: object

A cluster-scoped library entry in the Compute configuration YAML.

Show Source

• jar: string
  Minimum Length: 1

  Maximum Length: 2048

  JAR coordinate or workspace/volume path.
• path: string
  Minimum Length: 1

  Maximum Length: 2048

  Workspace or volume path containing library configuration.
• pip: string
  Minimum Length: 1

  Maximum Length: 2048

  Python package identifier.

{
    "type":"object",
    "description":"A cluster-scoped library entry in the Compute configuration YAML.",
    "properties":{
        "path":{
            "type":"string",
            "description":"Workspace or volume path containing library configuration.",
            "minLength":1,
            "maxLength":2048
        },
        "pip":{
            "type":"string",
            "description":"Python package identifier.",
            "minLength":1,
            "maxLength":2048
        },
        "jar":{
            "type":"string",
            "description":"JAR coordinate or workspace/volume path.",
            "minLength":1,
            "maxLength":2048
        }
    }
}

Back to Top

Response

Supported Media Types

• application/x-yaml

200 Response

YAML workspace file created.

Headers

• content-location: string(uri-reference)
  Same as location.
• location: string(uri-reference)
  URL for the created workspace object.
• 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.
• path: string
  Full path of the YAML workspace object.
• time-updated: string(date-time)
  Date and time when the YAML workspace object was created.
• type: string
  Workspace object type.

Body ()

Root Schema : schema

Type: string(binary)

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