Skip to main content

ListHosts

Retrieves a list of hosts for the specified Apache Kafka® 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 Apache Kafka® cluster.

To get the Apache Kafka® cluster ID, make 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​

List of hosts.

nextPageToken : string​

Token that 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​

Cluster host metadata.

Role​
  • ROLE_UNSPECIFIED

    Role of the host is unspecified. Default value.

  • KAFKA

    The host is a Kafka broker.

  • ZOOKEEPER

    The host is a ZooKeeper server.

Health​
  • UNKNOWN

    Health of the host is unknown. Default value.

  • 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 host.

clusterId : string​

ID of the Apache Kafka® cluster.

zoneId : string​

ID of the availability zone where the host resides.

role : Role​

Host role. If the field has default value, it is not returned in the response.

resources : Resources​

Computational resources allocated to the host.

health : Health​

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

subnetId : string​

ID of the subnet the host resides in.

assignPublicIp : bool​

The flag that defines whether a public IP address is assigned to the node.

If the value is true, then this node is available on the Internet via it's public IP address.

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. Must be greater than 2 partition segment size in bytes partitions count, so each partition can have one active segment file and one closed segment file that can be deleted.

diskTypeId : string​

Type of the storage environment for the host.