Yandex.Cloud
  • Services
  • Why Yandex.Cloud
  • Pricing
  • Documentation
  • Contact us
Get started
Yandex Data Proc
  • Use cases
    • Configuring networks for Data Proc clusters
    • Using Apache Hive
    • Running Spark applications
    • Running applications from a remote host
    • Copying files from Yandex Object Storage
  • Step-by-step instructions
    • All instructions
    • Creating clusters
    • Connecting to clusters
    • Updating subclusters
    • Managing subclusters
    • Deleting clusters
  • Concepts
    • Data Proc overview
    • Host classes
    • Hadoop and component versions
    • Component interfaces and ports
    • Component web interfaces
    • Auto scaling
    • Decommissioning subclusters and hosts
    • Network in Data Proc
    • Quotas and limits
  • Access management
  • Pricing policy
  • API reference
    • Authentication in the API
    • gRPC
      • Overview
      • ClusterService
      • JobService
      • ResourcePresetService
      • SubclusterService
      • OperationService
    • REST
      • Overview
      • Cluster
        • Overview
        • create
        • delete
        • get
        • list
        • listHosts
        • listOperations
        • listUILinks
        • start
        • stop
        • update
      • Job
        • Overview
        • create
        • get
        • list
        • listLog
      • ResourcePreset
        • Overview
        • get
        • list
      • Subcluster
        • Overview
        • create
        • delete
        • get
        • list
        • update
  • Questions and answers
  1. API reference
  2. REST
  3. Cluster
  4. list

Method list

  • HTTP request
  • Query parameters
  • Response

Retrieves the list of clusters in the specified folder.

HTTP request

GET https://dataproc.api.cloud.yandex.net/dataproc/v1/clusters

Query parameters

Parameter Description
folderId Required. ID of the folder to list clusters in. To get the folder ID make a list request. The maximum string length in characters is 50.
pageSize The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Default value: 100. The maximum value is 1000.
pageToken Page token. To get the next page of results, set page_token to the nextPageToken returned by a previous list request. The maximum string length in characters is 100.
filter 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. Can be either = or != for single values, IN or NOT IN for lists of values. 3. The value. 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`. The maximum string length in characters is 1000.

Response

HTTP Code: 200 - OK

{
  "clusters": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "monitoring": [
        {
          "name": "string",
          "description": "string",
          "link": "string"
        }
      ],
      "config": {
        "versionId": "string",
        "hadoop": {
          "services": [
            "string"
          ],
          "properties": "object",
          "sshPublicKeys": [
            "string"
          ]
        }
      },
      "health": "string",
      "status": "string",
      "zoneId": "string",
      "serviceAccountId": "string",
      "bucket": "string",
      "uiProxy": true
    }
  ],
  "nextPageToken": "string"
}
Field Description
clusters[] object

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

clusters[].
id
string

ID of the cluster. Generated at creation time.

clusters[].
folderId
string

ID of the folder that the cluster belongs to.

clusters[].
createdAt
string (date-time)

Creation timestamp.

String in RFC3339 text format.

clusters[].
name
string

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

The string length in characters must be 1-63.

clusters[].
description
string

Description of the cluster.

The string length in characters must be 0-256.

clusters[].
labels
object

Cluster labels as key:value pairs.

No more than 64 per resource.

clusters[].
monitoring[]
object

Metadata of a monitoring system for a Data Proc cluster.

clusters[].
monitoring[].
name
string

Name of the monitoring system.

clusters[].
monitoring[].
description
string

Description of the monitoring system.

clusters[].
monitoring[].
link
string

Link to the monitoring system.

clusters[].
config
object

Configuration of the cluster.

clusters[].
config.
versionId
string

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

clusters[].
config.
hadoop
object

Data Proc specific configuration options.

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

clusters[].
config.
hadoop.
services[]
string

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

clusters[].
config.
hadoop.
properties
object

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.

clusters[].
config.
hadoop.
sshPublicKeys[]
string

List of public SSH keys to access to cluster hosts.

clusters[].
health
string

Aggregated cluster health.

  • HEALTH_UNKNOWN: State of the cluster is unknown (health for every host in the cluster is UNKNOWN).
  • ALIVE: Cluster is alive and well (health for every host in the cluster is ALIVE).
  • DEAD: Cluster is inoperable (health for every host in the cluster is DEAD).
  • DEGRADED: Cluster is working below capacity (health for at least one host in the cluster is not ALIVE).
clusters[].
status
string

Cluster 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.
clusters[].
zoneId
string

ID of the availability zone where the cluster resides.

clusters[].
serviceAccountId
string

ID of service account for the Data Proc manager agent.

clusters[].
bucket
string

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

clusters[].
uiProxy
boolean (boolean)

Whether UI Proxy feature is enabled.

nextPageToken string

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

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

In this article:
  • HTTP request
  • Query parameters
  • Response
Language
Careers
Privacy policy
Terms of use
© 2021 Yandex.Cloud LLC