Skip to main content

List

Retrieves the list of clusters in the specified folder.

import { cloudApi, serviceClients, Session } from "@yandex-cloud/nodejs-sdk";

const ListClustersRequest =
  cloudApi.dataproc.cluster_service.ListClustersRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.ClusterServiceClient);

  const result = await client.list(
    ListClustersRequest.fromPartial({
      folderId: "folderId",
      // pageSize: 0,
      // pageToken: "pageToken",
      // filter: "filter"
    })
  );
  console.log(result);
})();

ListClustersRequest​

folderId : string​

ID of the folder to list clusters in.

To get the folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request.

pageSize : 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 ListClustersResponse.next_page_token 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 ListClustersResponse.next_page_token returned by a previous list request.

filter : string​

A filter expression that filters clusters listed in the response.

The expression must specify:

  1. The field name. Currently you can use filtering only on Cluster.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=my-cluster.

ListClustersResponse​

clusters : Cluster​

List of clusters in the specified folder.

nextPageToken : string​

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

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

Cluster​

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

Status​
  • STATUS_UNKNOWN

    Cluster state is unknown.

  • CREATING

    Cluster is being created.

  • RUNNING

    Cluster is running normally.

  • ERROR

    Cluster encountered a problem and cannot operate.

  • STOPPING

    Cluster is stopping.

  • STOPPED

    Cluster stopped.

  • STARTING

    Cluster is starting.

id : string​

ID of the cluster. Generated at creation time.

folderId : string​

ID of the folder that the cluster belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

name : string​

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

description : string​

Description of the cluster.

labels : string​

Cluster labels as key:value pairs.

monitoring : Monitoring​

Monitoring systems relevant to the cluster.

config : ClusterConfig​

Configuration of the cluster.

health : Health​

Aggregated cluster health.

status : Status​

Cluster status.

zoneId : string​

ID of the availability zone where the cluster resides.

serviceAccountId : string​

ID of service account for the Data Proc manager agent.

bucket : string​

Object Storage bucket to be used for Data Proc jobs that are run in the cluster.

uiProxy : bool​

Whether UI Proxy feature is enabled.

securityGroupIds : string​

User security groups.

hostGroupIds : string​

Host groups hosting VMs of the cluster.

deletionProtection : bool​

Deletion Protection inhibits deletion of the cluster

logGroupId : string​

ID of the cloud logging log group to write logs. If not set, default log group for the folder will be used. To prevent logs from being sent to the cloud set cluster property dataproc:disable_cloud_logging = true

Monitoring​

Metadata of a monitoring system for a Data Proc cluster.

name : string​

Name of the monitoring system.

description : string​

Description of the monitoring system.

Link to the monitoring system.

ClusterConfig​

versionId : string​

Image version for cluster provisioning. All available versions are listed in the documentation.

hadoop : HadoopConfig​

Data Proc specific configuration options.

HadoopConfig​

Hadoop configuration that describes services installed in a cluster, their properties and settings.

Service​
  • SERVICE_UNSPECIFIED

  • HDFS

  • YARN

  • MAPREDUCE

  • HIVE

  • TEZ

  • ZOOKEEPER

  • HBASE

  • SQOOP

  • FLUME

  • SPARK

  • ZEPPELIN

  • OOZIE

  • LIVY

services : Service​

Set of services used in the cluster (if empty, the default set is used).

properties : string​

Properties set for all hosts in *-site.xml configurations. The key should indicate the service and the property.

For example, use the key 'hdfs:dfs.replication' to set the dfs.replication property in the file /etc/hadoop/conf/hdfs-site.xml.

sshPublicKeys : string​

List of public SSH keys to access to cluster hosts.

initializationActions : InitializationAction​

Set of init-actions

InitializationAction​

uri : string​

URI of the executable file

args : string​

Arguments to the initialization action

timeout : int64​

Execution timeout