Managed Service for Elasticsearch API, gRPC: ClusterService.ListHosts
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 |
pageToken |
string Page token. To get the next page of results, set |
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[] |
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 |
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.
|
resources |
|
health |
enum Health Aggregated host health data. If the field has default value, it is not returned in the response.
|
services[] |
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 |
Resources
Computational resources.
Field |
Description |
resourcePresetId |
string ID of the preset for computational resources available to a host (CPU, memory etc.). |
diskSize |
int64 Volume of the storage available to a host, in bytes. |
diskTypeId |
string Type of the storage environment for the host. |
Service
Cluster service metadata.
Field |
Description |
type |
enum Type Type of the service provided by the host.
|
health |
enum Health Service health data. If the field has default value, it is not returned in the response.
|