Contact UsGet started

Data Proc API, gRPC: SubclusterService.List

Written by
Updated at October 17, 2024

Retrieves a list of subclusters in the specified cluster.

gRPC request

rpc List (ListSubclustersRequest) returns (ListSubclustersResponse)

ListSubclustersRequest

{
  "clusterId": "string",
  "pageSize": "int64",
  "pageToken": "string",
  "filter": "string"
}

Field

Description

clusterId

string

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

pageSize

int64

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

pageToken

string

Page token. To get the next page of results, set page_token to the
ListSubclustersResponse.nextPageToken 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",
      "clusterId": "string",
      "createdAt": "google.protobuf.Timestamp",
      "name": "string",
      "role": "Role",
      "resources": {
        "resourcePresetId": "string",
        "diskTypeId": "string",
        "diskSize": "int64"
      },
      "subnetId": "string",
      "hostsCount": "int64",
      "assignPublicIp": "bool",
      "autoscalingConfig": {
        "maxHostsCount": "int64",
        "preemptible": "bool",
        "measurementDuration": "google.protobuf.Duration",
        "warmupDuration": "google.protobuf.Duration",
        "stabilizationDuration": "google.protobuf.Duration",
        "cpuUtilizationTarget": "double",
        "decommissionTimeout": "int64"
      },
      "instanceGroupId": "string"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

subclusters[]

Subcluster

List of subclusters in the specified cluster.

nextPageToken

string

Token for getting the next page of the list. If the number of results is greater than
the specified ListSubclustersRequest.pageSize, use next_page_token as the value
for the ListSubclustersRequest.pageToken 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.

clusterId

string

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

createdAt

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.

subnetId

string

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

hostsCount

int64

Number of hosts in the subcluster.

assignPublicIp

bool

Assign public ip addresses for all hosts in subcluter.

autoscalingConfig

AutoscalingConfig

Configuration for instance group based subclusters

instanceGroupId

string

ID of Compute Instance Group for autoscaling subclusters

Resources

Field

Description

resourcePresetId

string

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

diskTypeId

string

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

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

diskSize

int64

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

AutoscalingConfig

Field

Description

maxHostsCount

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.

measurementDuration

google.protobuf.Duration

Required field. Time in seconds allotted for averaging metrics.

warmupDuration

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.

stabilizationDuration

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.

cpuUtilizationTarget

double

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

decommissionTimeout

int64

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