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. listHosts

Method listHosts

  • HTTP request
  • Path parameters
  • Query parameters
  • Response

Retrieves the list of hosts in the specified cluster.

HTTP request

GET https://dataproc.api.cloud.yandex.net/dataproc/v1/clusters/{clusterId}/hosts

Path parameters

Parameter Description
clusterId ID of the cluster to list hosts for. To get a cluster ID, make a list request. The maximum string length in characters is 50.

Query parameters

Parameter Description
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 pageToken to the nextPageToken returned by a previous list request. The maximum string length in characters is 100.
filter A filter expression that filters hosts 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-host` The maximum string length in characters is 1000.

Response

HTTP Code: 200 - OK

{
  "hosts": [
    {
      "name": "string",
      "subclusterId": "string",
      "health": "string",
      "computeInstanceId": "string",
      "role": "string"
    }
  ],
  "nextPageToken": "string"
}
Field Description
hosts[] object

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

hosts[].
name
string

Name of the Data Proc host. The host name is assigned by Data Proc at creation time and cannot be changed. The name is generated to be unique across all existing Data Proc hosts in Yandex.Cloud, as it defines the FQDN of the host.

hosts[].
subclusterId
string

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

hosts[].
health
string

Host status code.

  • 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).
hosts[].
computeInstanceId
string

ID of the Compute virtual machine that is used as the Data Proc host.

hosts[].
role
string

Role of the host in the cluster.

  • 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
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
  • Path parameters
  • Query parameters
  • Response
Language
Careers
Privacy policy
Terms of use
© 2021 Yandex.Cloud LLC