Skip to main content

ListHosts

Retrieves a list of hosts for the specified cluster.

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

const ListClusterHostsRequest =
  cloudApi.dataproc.cluster_service.ListClusterHostsRequest;

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

  const result = await client.listHosts(
    ListClusterHostsRequest.fromPartial({
      // clusterId: "clusterId",
      // pageSize: 0,
      // pageToken: "pageToken",
      // filter: "filter"
    })
  );
  console.log(result);
})();

ListClusterHostsRequest​

clusterId : string​

ID of the ClickHouse cluster. To get the ClickHouse cluster ID use a ClusterService.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 ListClusterHostsResponse.next_page_token that can be used to get the next page of results in subsequent list requests.

pageToken : string​

Page token. To get the next page of results, set page_token to the ListClusterHostsResponse.next_page_token returned by the previous list request.

ListClusterHostsResponse​

hosts : Host​

Requested list of hosts for the cluster.

nextPageToken : string​

This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterHostsRequest.page_size, use the next_page_token as the value for the ListClusterHostsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

Host​

Type​
  • TYPE_UNSPECIFIED

    Host type is unspecified. Default value.

  • CLICKHOUSE

    ClickHouse host.

  • ZOOKEEPER

    ZooKeeper host.

Health​
  • UNKNOWN

    Health of the host is unknown.

  • ALIVE

    The host is performing all its functions normally.

  • DEAD

    The host is inoperable, and cannot perform any of its essential functions.

  • DEGRADED

    The host is degraded, and can perform only some of its essential functions.

name : string​

Name of the ClickHouse host. The host name is assigned by MDB at creation time, and cannot be changed. 1-63 characters long.

The name is unique across all MDB hosts that exist on the platform, as it defines the FQDN of the host.

clusterId : string​

ID of the ClickHouse host. The ID is assigned by MDB at creation time.

zoneId : string​

ID of the availability zone where the ClickHouse host resides.

type : Type​

Type of the host. If the field has default value, it is not returned in the response.

resources : Resources​

Resources allocated to the ClickHouse host.

health : Health​

Aggregated health of the host. If the field has default value, it is not returned in the response.

services : Service​

Services provided by the host.

subnetId : string​

ID of the subnet that the host belongs to.

assignPublicIp : bool​

Flag showing public IP assignment status to this host.

shardName : string​

Resources​

resourcePresetId : string​

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

diskSize : int64​

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

diskTypeId : string​

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

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

Service​

Type​
  • TYPE_UNSPECIFIED

    Service type of the host is unspecified. Default value.

  • CLICKHOUSE

    The host is a ClickHouse server.

  • ZOOKEEPER

    The host is a ZooKeeper server.

Health​
  • UNKNOWN

    Health of the server is unknown. Default value.

  • ALIVE

    The server is working normally.

  • DEAD

    The server is dead or unresponsive.

type : Type​

Type of the service provided by the host. If the field has default value, it is not returned in the response.

health : Health​

Aggregated health of the service. If the field has default value, it is not returned in the response.