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 OpenSearch cluster. To get the OpenSearch 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 has its own next_page_token to continue paging through the results.

Host​

An OpenSearch cluster host resource.

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 working below capacity or not fully functional.

Type​
  • TYPE_UNSPECIFIED

    Type of the host is unspecified. Default value.

  • OPENSEARCH

    An OpenSearch type host.

  • DASHBOARDS

    A Dashboards type host.

CPUMetric​

CPU usage of the host.

timestamp : int64​

Time of the record.

used : double​

Percentage of the CPU used.

MemoryMetric​

RAM usage of the host.

timestamp : int64​

Time of the record.

used : int64​

The amount of RAM used, in bytes.

total : int64​

Total amount of RAM allocated to the host.

DiskMetric​

Disk usage of the host.

timestamp : int64​

Time of the record.

used : int64​

The amount of disk space used, in bytes.

total : int64​

Total amount of disk space allocated to the host.

SystemMetrics​

Resources used by the host.

cpu : CPUMetric​

CPU usage of the host.

memory : MemoryMetric​

RAM usage of the host.

disk : DiskMetric​

Disk usage of the host.

name : string​

Required. Name of the OpenSearch host.

The host name is assigned by the platform at creation time and cannot be changed.

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

clusterId : string​

Required. ID of the OpenSearch cluster. The ID is assigned by the platform at creation time.

zoneId : string​

ID of the availability zone the OpenSearch host belongs to.

resources : Resources​

Resources allocated to the OpenSearch host.

type : Type​

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

health : Health​

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

subnetId : string​

ID of the subnet that the host belongs to.

assignPublicIp : bool​

Determines whether a public IP is assigned to the host.

system : SystemMetrics​

Resources used by the host.

nodeGroup : string​

Name of the host group that the host belongs to.

roles : OpenSearch.GroupRole​

Roles of the host.

CPUMetric​

CPU usage of the host.

timestamp : int64​

Time of the record.

used : double​

Percentage of the CPU used.

MemoryMetric​

RAM usage of the host.

timestamp : int64​

Time of the record.

used : int64​

The amount of RAM used, in bytes.

total : int64​

Total amount of RAM allocated to the host.

DiskMetric​

Disk usage of the host.

timestamp : int64​

Time of the record.

used : int64​

The amount of disk space used, in bytes.

total : int64​

Total amount of disk space allocated to the host.

Resources​

A list of computational resources allocated to a host.

resourcePresetId : string​

ID of the preset for computational resources allocated to a host.

diskSize : int64​

Volume of the storage used by the host, in bytes.

diskTypeId : string​

Type of the storage used by the host: network-hdd, network-ssd or local-ssd.

SystemMetrics​

Resources used by the host.

cpu : CPUMetric​

CPU usage of the host.

memory : MemoryMetric​

RAM usage of the host.

disk : DiskMetric​

Disk usage of the host.