Skip to main content

ListMasterHosts

Retrieves a list of master 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.listMasterHosts(
ListClusterHostsRequest.fromPartial({
// clusterId: "clusterId",
// pageSize: 0,
// pageToken: "pageToken",
// filter: "filter"
})
);
console.log(result);
})();

ListClusterHostsRequest​

clusterId : string​

ID of the Greenplum® cluster.

To get the Greenplum® 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​

A Greenplum® cluster host resource.

Type​
  • TYPE_UNSPECIFIED

    Host type is not specified. Default value.

  • MASTER

    A Greenplum® master host.

  • REPLICA

    A Greenplum® master replica host.

  • SEGMENT

    A Greenplum® segment host.

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.

  • UNBALANCED

    One or more segments are not in the preferred role.

name : string​

Name of the Greenplum® 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​

ID of the Greenplum® cluster. The ID is assigned by the platform at creation time.

zoneId : string​

ID of the availability zone the Greenplum® host belongs to.

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 Greenplum® host.

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.

Resources​

resourcePresetId : string​

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

Available presets are listed in the documentation.

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.