Skip to main content

ListHosts

Retrieves the list of hosts for the specified SQL Server 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 SQL Server cluster.

To get the SQL Server 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​

List of SQL Server 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 has its own next_page_token to continue paging through the results.

Host​

Role​
  • ROLE_UNKNOWN

    Role of the host in the cluster is unknown.

  • MASTER

    Host is the master SQL Server instance in the cluster.

  • REPLICA

    Host is a replica SQL Server instance in the cluster.

Health​
  • 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 SQL Server host.

The host name is assigned by Managed Service for SQL Server at the moment of creation and cannot be changed. 1-63 characters long.

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

clusterId : string​

ID of the SQL Server host.

The ID is assigned by Managed Service for SQL Server at the moment of creation.

zoneId : string​

ID of the availability zone where the SQL Server host resides.

resources : Resources​

Resources allocated to the host.

role : Role​

Role of the host in the cluster.

health : Health​

Status code of the aggregated health of the host.

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.

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.

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

  • SQLSERVER

    SQL Server service.

Health​
  • HEALTH_UNKNOWN

    Health of the server is unknown.

  • ALIVE

    The server is working normally.

  • DEAD

    The server is dead or unresponsive.

type : Type​

Type of the service provided by the host.

health : Health​

Status code of server availability.