Managed Spark API, gRPC: ClusterService.List
Retrieves a list of Spark clusters.
gRPC request
rpc List (ListClustersRequest) returns (ListClustersResponse)
ListClustersRequest
{
"folder_id": "string",
"page_size": "int64",
"page_token": "string",
"filter": "string"
}
|
Field |
Description |
|
folder_id |
string Required field. ID of the folder to list Spark clusters in. |
|
page_size |
int64 The maximum number of results per page that should be returned. If the number of available |
|
page_token |
string Page token. Set |
|
filter |
string String that describes a display filter. |
ListClustersResponse
{
"clusters": [
{
"id": "string",
"folder_id": "string",
"created_at": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "map<string, string>",
"config": {
"resource_pools": {
"driver": {
"resource_preset_id": "string",
"scale_policy": {
// Includes only one of the fields `fixed_scale`, `auto_scale`
"fixed_scale": {
"size": "int64"
},
"auto_scale": {
"min_size": "int64",
"max_size": "int64"
}
// end of the list of possible fields
}
},
"executor": {
"resource_preset_id": "string",
"scale_policy": {
// Includes only one of the fields `fixed_scale`, `auto_scale`
"fixed_scale": {
"size": "int64"
},
"auto_scale": {
"min_size": "int64",
"max_size": "int64"
}
// end of the list of possible fields
}
}
},
"history_server": {
"enabled": "bool"
},
"dependencies": {
"pip_packages": [
"string"
],
"deb_packages": [
"string"
]
},
"metastore": {
"cluster_id": "string"
}
},
"status": "Status",
"network": {
"subnet_ids": [
"string"
],
"security_group_ids": [
"string"
]
},
"deletion_protection": "bool",
"service_account_id": "string",
"logging": {
"enabled": "bool",
// Includes only one of the fields `folder_id`, `log_group_id`
"folder_id": "string",
"log_group_id": "string"
// end of the list of possible fields
},
"health": "Health",
"links": [
{
"name": "string",
"url": "string"
}
],
"maintenance_window": {
// Includes only one of the fields `anytime`, `weekly_maintenance_window`
"anytime": "AnytimeMaintenanceWindow",
"weekly_maintenance_window": {
"day": "WeekDay",
"hour": "int64"
}
// end of the list of possible fields
},
"planned_operation": {
"info": "string",
"delayed_until": "google.protobuf.Timestamp",
"latest_maintenance_time": "google.protobuf.Timestamp",
"next_maintenance_window_time": "google.protobuf.Timestamp"
}
}
],
"next_page_token": "string"
}
|
Field |
Description |
|
clusters[] |
Requested list of Spark clusters. |
|
next_page_token |
string This token allows you to get the next page of results for ListClusters requests, |
Cluster
Spark cluster.
|
Field |
Description |
|
id |
string Required field. Unique ID of the Spark cluster. |
|
folder_id |
string ID of the folder that the Spark cluster belongs to. |
|
created_at |
The time when the Spark cluster was created. |
|
name |
string Name of the Spark cluster. |
|
description |
string Description of the Spark cluster. 0-256 characters long. |
|
labels |
object (map<string, string>) |
|
config |
Configuration of the Spark cluster. |
|
status |
enum Status Cluster status.
|
|
network |
|
|
deletion_protection |
bool Deletion Protection inhibits deletion of the cluster |
|
service_account_id |
string Service account that will be used to access a YC resources |
|
logging |
Cloud logging configuration. |
|
health |
enum Health Aggregated cluster health.
|
|
links[] |
UI URLs |
|
maintenance_window |
Window of maintenance operations. |
|
planned_operation |
Maintenance operation planned at nearest maintenance_window. |
ClusterConfig
|
Field |
Description |
|
resource_pools |
Required field. |
|
history_server |
Configuration for HistoryServer |
|
dependencies |
Container custom environment dependencies |
|
metastore |
Metastore Cluster |
ResourcePools
|
Field |
Description |
|
driver |
Required field. |
|
executor |
Required field. |
ResourcePool
|
Field |
Description |
|
resource_preset_id |
string Required field. ID of the preset for computational resources allocated to a instance (e.g., CPU, memory, etc.). |
|
scale_policy |
Required field. |
ScalePolicy
|
Field |
Description |
|
fixed_scale |
Includes only one of the fields |
|
auto_scale |
Includes only one of the fields |
FixedScale
|
Field |
Description |
|
size |
int64 |
AutoScale
|
Field |
Description |
|
min_size |
int64 |
|
max_size |
int64 |
HistoryServerConfig
|
Field |
Description |
|
enabled |
bool |
Dependencies
|
Field |
Description |
|
pip_packages[] |
string |
|
deb_packages[] |
string |
Metastore
|
Field |
Description |
|
cluster_id |
string |
NetworkConfig
|
Field |
Description |
|
subnet_ids[] |
string IDs of VPC network subnets where instances of the cluster are attached. |
|
security_group_ids[] |
string User security groups |
LoggingConfig
|
Field |
Description |
|
enabled |
bool |
|
folder_id |
string Includes only one of the fields |
|
log_group_id |
string Includes only one of the fields |
UILink
|
Field |
Description |
|
name |
string |
|
url |
string |
MaintenanceWindow
|
Field |
Description |
|
anytime |
Includes only one of the fields |
|
weekly_maintenance_window |
Includes only one of the fields |
AnytimeMaintenanceWindow
|
Field |
Description |
|
Empty |
|
WeeklyMaintenanceWindow
|
Field |
Description |
|
day |
enum WeekDay
|
|
hour |
int64 Hour of the day in UTC. |
MaintenanceOperation
|
Field |
Description |
|
info |
string |
|
delayed_until |
|
|
latest_maintenance_time |
|
|
next_maintenance_window_time |