Managed Service for OpenSearch API, gRPC: ClusterService.ListHosts
Retrieves a list of hosts for the specified cluster.
gRPC request
rpc ListHosts (ListClusterHostsRequest) returns (ListClusterHostsResponse)
ListClusterHostsRequest
{
"clusterId": "string",
"pageSize": "int64",
"pageToken": "string"
}
|
Field |
Description |
|
clusterId |
string Required field. ID of the OpenSearch cluster. |
|
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",
"resources": {
"resourcePresetId": "string",
"diskSize": "int64",
"diskTypeId": "string"
},
"type": "Type",
"health": "Health",
"subnetId": "string",
"assignPublicIp": "bool",
"system": {
"cpu": {
"timestamp": "int64",
"used": "double"
},
"memory": {
"timestamp": "int64",
"used": "int64",
"total": "int64"
},
"disk": {
"timestamp": "int64",
"used": "int64",
"total": "int64"
}
},
"nodeGroup": "string",
"roles": [
"GroupRole"
]
}
],
"nextPageToken": "string"
}
|
Field |
Description |
|
hosts[] |
Requested list of hosts for the cluster. |
|
nextPageToken |
string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterHostsRequest.pageSize, use the Each subsequent list request has its own |
Host
An OpenSearch cluster host resource.
|
Field |
Description |
|
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. |
|
clusterId |
string Required. ID of the OpenSearch cluster. The ID is assigned by the platform at creation time. |
|
zoneId |
string ID of the availability zone the OpenSearch host belongs to. |
|
resources |
Resources allocated to the OpenSearch host. |
|
type |
enum Type Type of the host. If the field has default value, it is not returned in the response.
|
|
health |
enum Health Aggregated health of the host. If the field has default value, it is not returned in the response.
|
|
subnetId |
string ID of the subnet that the host belongs to. |
|
assignPublicIp |
bool Determines whether a public IP is assigned to the host. |
|
system |
Resources used by the host. |
|
nodeGroup |
string Name of the host group that the host belongs to. |
|
roles[] |
enum GroupRole Roles of the host.
|
Resources
A list of computational resources allocated to a host.
|
Field |
Description |
|
resourcePresetId |
string ID of the preset for computational resources allocated to a host. |
|
diskSize |
int64 Volume of the storage used by the host, in bytes. |
|
diskTypeId |
string Type of the storage used by the host: |
SystemMetrics
Resources used by the host.
|
Field |
Description |
|
cpu |
CPU usage of the host. |
|
memory |
RAM usage of the host. |
|
disk |
Disk usage of the host. |
CPUMetric
CPU usage of the host.
|
Field |
Description |
|
timestamp |
int64 Time of the record. |
|
used |
double Percentage of the CPU used. |
MemoryMetric
RAM usage of the host.
|
Field |
Description |
|
timestamp |
int64 Time of the record. |
|
used |
int64 The amount of RAM used, in bytes. |
|
total |
int64 Total amount of RAM allocated to the host. |
DiskMetric
Disk usage of the host.
|
Field |
Description |
|
timestamp |
int64 Time of the record. |
|
used |
int64 The amount of disk space used, in bytes. |
|
total |
int64 Total amount of disk space allocated to the host. |