Scaleway logo
Clusters for Apache Spark™ API

scaleway.datalab.v1beta1.Cluster

name
​string

The name of the cluster.

description
​string

The description of the cluster.

The versions of the cluster.

scaleway.datalab.v1beta1.ClusterVersion

version
​string

The version of the cluster.

end_of_life
​string | null · date-time

The end of life date of the cluster version. (RFC 3339 format)

created_at
​string | null · date-time

The creation date of the cluster version. (RFC 3339 format)

updated_at
​string | null · date-time

The last update date of the cluster version. (RFC 3339 format)

disabled
​boolean

Whether the cluster version is disabled.

beta
​boolean

Whether the cluster version is in beta.

scaleway.datalab.v1beta1.CreateDatalabRequest.SparkMain

node_type
​string

scaleway.datalab.v1beta1.CreateDatalabRequest.SparkWorker

node_type
​string
node_count
​integer · uint32

scaleway.datalab.v1beta1.Datalab

id
​string

The unique identifier of the cluster. (UUID format)

project_id
​string

The unique identifier of the project where the cluster has been created. (UUID format)

name
​string

The name of the cluster.

description
​string

The description of the cluster.

tags
​string[]

The tags of the cluster.

The Apache Spark™ Main node specification of cluster. It holds the parameters node_type, spark_ui_url (available to reach Apache Spark™ UI), spark_master_url (used to reach the cluster within a VPC), root_volume (size of the volume assigned to the cluster).

The cluster worker nodes specification. It holds the parameters node_type, node_count, root_volume (size of the volume assigned to the cluster).

The status of the cluster. For a working cluster the status is marked as ready.

Enum values:
unknown_status
creating
updating
ready
error
deleting
locked
deleted
Default: unknown_status
created_at
​string | null · date-time

The creation timestamp of the cluster. (RFC 3339 format)

updated_at
​string | null · date-time

The last update date of the cluster. (RFC 3339 format)

region
​string

The region of the cluster.

has_notebook
​boolean

Whether a JupyterLab notebook is associated with the cluster or not.

notebook_url
​string | null

The URL of the notebook if available.

spark_version
​string

The version of Apache Spark™ running inside the cluster.

The total persistent volume storage selected to run Apache Spark™.

private_network_id
​string

The unique identifier of the private network to which the cluster is attached to. (UUID format)

notebook_master_url
​string | null

The URL that is used to reach the cluster from the notebook when available. This URL cannot be used to reach the cluster from a server.

scaleway.datalab.v1beta1.Datalab.SparkMain

node_type
​string
spark_ui_url
​string
spark_master_url
​string

scaleway.datalab.v1beta1.Datalab.SparkWorker

node_type
​string
node_count
​integer · uint32

scaleway.datalab.v1beta1.Datalab.Status

string · enum
Enum values:
unknown_status
creating
updating
ready
error
deleting
locked
deleted
Default: unknown_status

scaleway.datalab.v1beta1.ListClusterVersionsRequest.OrderBy

string · enum
Enum values:
name_asc
name_desc
Default: name_asc

scaleway.datalab.v1beta1.ListClusterVersionsResponse

The list of cluster versions.

total_count
​integer · uint64

The total count of cluster versions.

scaleway.datalab.v1beta1.ListDatalabsRequest.OrderBy

string · enum
Enum values:
name_asc
name_desc
created_at_asc
created_at_desc
updated_at_asc
updated_at_desc
Default: name_asc

scaleway.datalab.v1beta1.ListDatalabsResponse

The list of clusters. This is a list composed of messages of type DataLab.

total_count
​integer · uint64

The total count of clusters.

scaleway.datalab.v1beta1.ListNodeTypesRequest.OrderBy

string · enum
Enum values:
name_asc
name_desc
vcpus_asc
vcpus_desc
memory_gigabytes_asc
memory_gigabytes_desc
vram_bytes_asc
vram_bytes_desc
Default: name_asc

scaleway.datalab.v1beta1.ListNodeTypesRequest.ResourceType

string · enum
Enum values:
all
gpu
cpu
Default: all

scaleway.datalab.v1beta1.ListNodeTypesResponse

The list of node types.

total_count
​integer · uint64

The total count of node types.

scaleway.datalab.v1beta1.ListNotebookVersionsRequest.OrderBy

string · enum
Enum values:
name_asc
name_desc
Default: name_asc

scaleway.datalab.v1beta1.ListNotebookVersionsResponse

The list of notebook versions.

total_count
​integer · uint64

The total count of notebook versions.

scaleway.datalab.v1beta1.NodeType

The stock status of the node type.

Enum values:
unknown_stock
low_stock
out_of_stock
available
Default: unknown_stock
name
​string

The name of the node type.

description
​string

The description of the node type.

vcpus
​integer · uint32

The number of vCPUs.

memory_gigabytes
​integer · uint64

The amount of memory.

vram_gigabytes
​integer · uint64

The amount of VRAM.

gpus
​integer · uint32

The number of GPUs.

disabled
​boolean

Whether the node type is disabled.

beta
​boolean

Whether the node type is in beta.

created_at
​string | null · date-time

The creation date of the node type. (RFC 3339 format)

updated_at
​string | null · date-time

The last update date of the node type. (RFC 3339 format)

The targets of the node type.

Enum values:
unknown_target
notebook
worker

scaleway.datalab.v1beta1.NodeType.Stock

string · enum
Enum values:
unknown_stock
low_stock
out_of_stock
available
Default: unknown_stock

scaleway.datalab.v1beta1.NodeType.Target

string · enum
Enum values:
unknown_target
notebook
worker
Default: unknown_target

scaleway.datalab.v1beta1.Notebook

name
​string

The name of the notebook.

description
​string

The description of the notebook.

The versions of the notebook.

scaleway.datalab.v1beta1.NotebookVersion

version
​string

The version of the notebook.

end_of_life
​string | null · date-time

The end of life date of the notebook version. (RFC 3339 format)

created_at
​string | null · date-time

The creation date of the notebook version. (RFC 3339 format)

updated_at
​string | null · date-time

The last update date of the notebook version. (RFC 3339 format)

disabled
​boolean

Whether the notebook version is disabled.

beta
​boolean

Whether the notebook version is in beta.

scaleway.datalab.v1beta1.Volume

Enum values:
unknown_type
sbs_5k
Default: unknown_type
size
​integer · uint64

(in bytes)

scaleway.datalab.v1beta1.Volume.Type

string · enum
Enum values:
unknown_type
sbs_5k
Default: unknown_type