Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Managed Service for Elasticsearch API, gRPC: ClusterService.ListHosts

Written by
Updated at October 17, 2024

Retrieves a list of hosts for the specified Elasticsearch cluster.

gRPC request

rpc ListHosts (ListClusterHostsRequest) returns (ListClusterHostsResponse)

ListClusterHostsRequest

{
  "clusterId": "string",
  "pageSize": "int64",
  "pageToken": "string"
}

Field

Description

clusterId

string

Required field. ID of the Elasticsearch cluster.

To get the Elasticsearch 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.nextPageToken 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.nextPageToken returned by the previous list request.

ListClusterHostsResponse

{
  "hosts": [
    {
      "name": "string",
      "clusterId": "string",
      "zoneId": "string",
      "type": "Type",
      "resources": {
        "resourcePresetId": "string",
        "diskSize": "int64",
        "diskTypeId": "string"
      },
      "health": "Health",
      "services": [
        {
          "type": "Type",
          "health": "Health"
        }
      ],
      "subnetId": "string",
      "assignPublicIp": "bool"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

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.pageSize, use the next_page_token as the value for the ListClusterHostsRequest.pageToken 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.

Field

Description

name

string

Name of the host.

clusterId

string

ID of the Elasticsearch cluster.

zoneId

string

ID of the availability zone where the host resides.

type

enum Type

Host type.

  • TYPE_UNSPECIFIED: Host type is unspecified. Default value.
  • DATA_NODE: The host is an Elasticsearch data node.
  • MASTER_NODE: The host is an Elasticsearch master node.

resources

Resources

health

enum Health

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

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

services[]

Service

Services provided by the host.

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

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

Resources

Computational resources.

Field

Description

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.
All available types are listed in the documentation.

Service

Cluster service metadata.

Field

Description

type

enum Type

Type of the service provided by the host.

  • TYPE_UNSPECIFIED
  • ELASTICSEARCH: The Elasticsearch service.

health

enum Health

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

  • UNKNOWN: Health of the service is unknown.
  • ALIVE: The service is working normally.
  • DEAD: The service is dead or unresponsive.
Previous
ListOperations
Next
AddHosts