Managed Service for OpenSearch API, REST: Cluster.listHosts
Retrieves a list of hosts for the specified cluster.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-opensearch/v1/clusters/{clusterId}/hosts
Path parameters
Parameter | Description |
---|---|
clusterId | Required. ID of the OpenSearch cluster. To get the OpenSearch cluster ID use 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 pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
pageToken | Page token. To get the next page of results, set pageToken to the nextPageToken returned by the previous list request. The maximum string length in characters is 100. |
Response
HTTP Code: 200 - OK
{
"hosts": [
{
"name": "string",
"clusterId": "string",
"zoneId": "string",
"resources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
},
"type": "string",
"health": "string",
"subnetId": "string",
"assignPublicIp": true,
"system": {
"cpu": {
"timestamp": "string",
"used": "number"
},
"memory": {
"timestamp": "string",
"used": "string",
"total": "string"
},
"disk": {
"timestamp": "string",
"used": "string",
"total": "string"
}
},
"nodeGroup": "string",
"roles": [
"string"
]
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
hosts[] | object Requested list of hosts for the cluster. |
hosts[]. name |
string Required. Name of the OpenSearch 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. |
hosts[]. clusterId |
string Required. ID of the OpenSearch cluster. The ID is assigned by the platform at creation time. |
hosts[]. zoneId |
string ID of the availability zone the OpenSearch host belongs to. |
hosts[]. resources |
object Resources allocated to the OpenSearch host. A list of computational resources allocated to a host. |
hosts[]. resources. resourcePresetId |
string ID of the preset for computational resources allocated to a host. |
hosts[]. resources. diskSize |
string (int64) Volume of the storage used by the host, in bytes. |
hosts[]. resources. diskTypeId |
string Type of the storage used by the host: |
hosts[]. type |
string Type of the host. If the field has default value, it is not returned in the response.
|
hosts[]. health |
string Aggregated health of the host. If the field has default value, it is not returned in the response.
|
hosts[]. subnetId |
string ID of the subnet that the host belongs to. |
hosts[]. assignPublicIp |
boolean (boolean) Determines whether a public IP is assigned to the host. |
hosts[]. system |
object Resources used by the host. Resources used by the host. |
hosts[]. system. cpu |
object CPU usage of the host. CPU usage of the host. |
hosts[]. system. cpu. timestamp |
string (int64) Time of the record. |
hosts[]. system. cpu. used |
number (double) Percentage of the CPU used. |
hosts[]. system. memory |
object RAM usage of the host. RAM usage of the host. |
hosts[]. system. memory. timestamp |
string (int64) Time of the record. |
hosts[]. system. memory. used |
string (int64) The amount of RAM used, in bytes. |
hosts[]. system. memory. total |
string (int64) Total amount of RAM allocated to the host. |
hosts[]. system. disk |
object Disk usage of the host. Disk usage of the host. |
hosts[]. system. disk. timestamp |
string (int64) Time of the record. |
hosts[]. system. disk. used |
string (int64) The amount of disk space used, in bytes. |
hosts[]. system. disk. total |
string (int64) Total amount of disk space allocated to the host. |
hosts[]. nodeGroup |
string Name of the host group that the host belongs to. |
hosts[]. roles[] |
string Roles of the host. |
nextPageToken | string This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken query parameter in the next list request. Each subsequent list request has its own nextPageToken to continue paging through the results. |