Contact UsGet started

Data Proc API, gRPC: SubclusterService.List

Written by
Updated at November 26, 2024

Retrieves a list of subclusters in the specified cluster.

gRPC request

rpc List (ListSubclustersRequest) returns (ListSubclustersResponse)

ListSubclustersRequest

{
  "cluster_id": "string",
  "page_size": "int64",
  "page_token": "string",
  "filter": "string"
}

Field

Description

cluster_id

string

Required field. ID of the Data Proc cluster to list subclusters in.

page_size

int64

The maximum number of results per page to return. If the number of available
results is larger than page_size, the service returns a ListSubclustersResponse.next_page_token
that can be used to get the next page of results in subsequent list requests.
Default value: 100.

page_token

string

Page token. To get the next page of results, set page_token to the
ListSubclustersResponse.next_page_token returned by a previous list request.

filter

string

A filter expression that filters subclusters listed in the response.

The expression must specify:

  1. The field name. Currently you can use filtering only on Subcluster.name field.
  2. An = operator.
  3. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9].
    Example of a filter: name=dataproc123_subcluster456.

ListSubclustersResponse

{
  "subclusters": [
    {
      "id": "string",
      "cluster_id": "string",
      "created_at": "google.protobuf.Timestamp",
      "name": "string",
      "role": "Role",
      "resources": {
        "resource_preset_id": "string",
        "disk_type_id": "string",
        "disk_size": "int64"
      },
      "subnet_id": "string",
      "hosts_count": "int64",
      "assign_public_ip": "bool",
      "autoscaling_config": {
        "max_hosts_count": "int64",
        "preemptible": "bool",
        "measurement_duration": "google.protobuf.Duration",
        "warmup_duration": "google.protobuf.Duration",
        "stabilization_duration": "google.protobuf.Duration",
        "cpu_utilization_target": "double",
        "decommission_timeout": "int64"
      },
      "instance_group_id": "string"
    }
  ],
  "next_page_token": "string"
}

Field

Description

subclusters[]

Subcluster

List of subclusters in the specified cluster.

next_page_token

string

Token for getting the next page of the list. If the number of results is greater than
the specified ListSubclustersRequest.page_size, use next_page_token as the value
for the ListSubclustersRequest.page_token parameter in the next list request.

Each subsequent page will have its own next_page_token to continue paging through the results.

Subcluster

A Data Proc subcluster. For details about the concept, see documentation.

Field

Description

id

string

ID of the subcluster. Generated at creation time.

cluster_id

string

ID of the Data Proc cluster that the subcluster belongs to.

created_at

google.protobuf.Timestamp

Creation timestamp.

name

string

Name of the subcluster. The name is unique within the cluster.

role

enum Role

Role that is fulfilled by hosts of the subcluster.

  • ROLE_UNSPECIFIED

  • MASTERNODE: The subcluster fulfills the master role.

    Master can run the following services, depending on the requested components:

  • HDFS: Namenode, Secondary Namenode
  • YARN: ResourceManager, Timeline Server
  • HBase Master
  • Hive: Server, Metastore, HCatalog
  • Spark History Server
  • Zeppelin
  • ZooKeeper

  • DATANODE: The subcluster is a DATANODE in a Data Proc cluster.

    DATANODE can run the following services, depending on the requested components:

  • HDFS DataNode
  • YARN NodeManager
  • HBase RegionServer
  • Spark libraries

  • COMPUTENODE: The subcluster is a COMPUTENODE in a Data Proc cluster.

    COMPUTENODE can run the following services, depending on the requested components:

  • YARN NodeManager
  • Spark libraries

resources

Resources

Resources allocated for each host in the subcluster.

subnet_id

string

ID of the VPC subnet used for hosts in the subcluster.

hosts_count

int64

Number of hosts in the subcluster.

assign_public_ip

bool

Assign public ip addresses for all hosts in subcluter.

autoscaling_config

AutoscalingConfig

Configuration for instance group based subclusters

instance_group_id

string

ID of Compute Instance Group for autoscaling subclusters

Resources

Field

Description

resource_preset_id

string

ID of the resource preset for computational resources available to a host (CPU, memory etc.).
All available presets are listed in the documentation.

disk_type_id

string

Type of the storage environment for the host.
Possible values:

  • network-hdd - network HDD drive,
  • network-ssd - network SSD drive.

disk_size

int64

Volume of the storage available to a host, in bytes.

AutoscalingConfig

Field

Description

max_hosts_count

int64

Upper limit for total instance subcluster count.

preemptible

bool

Preemptible instances are stopped at least once every 24 hours, and can be stopped at any time
if their resources are needed by Compute.
For more information, see Preemptible Virtual Machines.

measurement_duration

google.protobuf.Duration

Required field. Time in seconds allotted for averaging metrics.

warmup_duration

google.protobuf.Duration

The warmup time of the instance in seconds. During this time,
traffic is sent to the instance, but instance metrics are not collected.

stabilization_duration

google.protobuf.Duration

Minimum amount of time in seconds allotted for monitoring before
Instance Groups can reduce the number of instances in the group.
During this time, the group size doesn't decrease, even if the new metric values
indicate that it should.

cpu_utilization_target

double

Defines an autoscaling rule based on the average CPU utilization of the instance group.

decommission_timeout

int64

Timeout to gracefully decommission nodes during downscaling. In seconds. Default value: 120
Previous
Get
Next
Create