Managed Service for Elasticsearch API, REST: Cluster.listHosts
Retrieves a list of hosts for the specified Elasticsearch cluster.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-elasticsearch/v1/clusters/{clusterId}/hosts
Path parameters
Parameter | Description |
---|---|
clusterId | Required. ID of the Elasticsearch cluster. To get the Elasticsearch cluster ID, make a list request. The maximum string length in characters is 50. |
Query parameters
Parameter | Description |
---|---|
pageSize | The maximum number of results per page to return. If the number of available results is larger than The maximum value is 1000. |
pageToken | Page token. To get the next page of results, set The maximum string length in characters is 100. |
Response
HTTP Code: 200 - OK
{
"hosts": [
{
"name": "string",
"clusterId": "string",
"zoneId": "string",
"type": "string",
"resources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
},
"health": "string",
"services": [
{
"type": "string",
"health": "string"
}
],
"subnetId": "string",
"assignPublicIp": true
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
hosts[] | object List of hosts. |
hosts[]. name |
string Name of the host. |
hosts[]. clusterId |
string ID of the Elasticsearch cluster. |
hosts[]. zoneId |
string ID of the availability zone where the host resides. |
hosts[]. type |
string Host type.
|
hosts[]. resources |
object Computational resources. |
hosts[]. 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. |
hosts[]. resources. diskSize |
string (int64) Volume of the storage available to a host, in bytes. |
hosts[]. resources. diskTypeId |
string Type of the storage environment for the host. All available types are listed in the documentation. |
hosts[]. health |
string Aggregated host health data. If the field has default value, it is not returned in the response.
|
hosts[]. services[] |
object Services provided by the host. |
hosts[]. services[]. type |
string Type of the service provided by the host.
|
hosts[]. services[]. health |
string Service health data. If the field has default value, it is not returned in the response.
|
hosts[]. subnetId |
string ID of the subnet the host resides in. |
hosts[]. assignPublicIp |
boolean (boolean) The flag that defines whether a public IP address is assigned to the host. If the value is |
nextPageToken | string Token that allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the |