Skip to main content

Get

Returns the specified cluster.

To get the list of all available clusters, make a ClusterService.List request.

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

const GetClusterRequest = cloudApi.dataproc.cluster_service.GetClusterRequest;

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

  const result = await client.get(
    GetClusterRequest.fromPartial({
      clusterId: "clusterId",
    })
  );
  console.log(result);
})();

GetClusterRequest​

clusterId : string​

ID of the Data Proc cluster.

To get a cluster ID make a ClusterService.List request.

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