Managed Service for OpenSearch API, gRPC: ClusterService.ListHosts

Статья создана

Yandex Cloud

Обновлена 26 ноября 2024 г.

gRPC request
ListClusterHostsRequest
ListClusterHostsResponse
Host
Resources
SystemMetrics
CPUMetric
MemoryMetric
DiskMetric

Retrieves a list of hosts for the specified cluster.

gRPC request

rpc ListHosts (ListClusterHostsRequest) returns (ListClusterHostsResponse)

ListClusterHostsRequest

{
  "cluster_id": "string",
  "page_size": "int64",
  "page_token": "string"
}

Field	Description
cluster_id	string Required field. ID of the OpenSearch cluster. To get the OpenSearch cluster ID use a ClusterService.List request.
page_size	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.next_page_token that can be used to get the next page of results in subsequent list requests.
page_token	string Page token. To get the next page of results, set `page_token` to the ListClusterHostsResponse.next_page_token returned by the previous list request.

ListClusterHostsResponse

{
  "hosts": [
    {
      "name": "string",
      "cluster_id": "string",
      "zone_id": "string",
      "resources": {
        "resource_preset_id": "string",
        "disk_size": "int64",
        "disk_type_id": "string"
      },
      "type": "Type",
      "health": "Health",
      "subnet_id": "string",
      "assign_public_ip": "bool",
      "system": {
        "cpu": {
          "timestamp": "int64",
          "used": "double"
        },
        "memory": {
          "timestamp": "int64",
          "used": "int64",
          "total": "int64"
        },
        "disk": {
          "timestamp": "int64",
          "used": "int64",
          "total": "int64"
        }
      },
      "node_group": "string",
      "roles": [
        "GroupRole"
      ]
    }
  ],
  "next_page_token": "string"
}

Field

Description

hosts[]

Host

Requested list of hosts for the cluster.

next_page_token

string

This token allows you to get the next page of results for list requests.

If the number of results is larger than ListClusterHostsRequest.page_size, use the next_page_token
as the value for the ListClusterHostsRequest.page_token query parameter in the next list request.

Each subsequent list request has its own next_page_token to continue paging through the results.

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.
cluster_id	string Required. ID of the OpenSearch cluster. The ID is assigned by the platform at creation time.
zone_id	string ID of the availability zone the OpenSearch host belongs to.
resources	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. `TYPE_UNSPECIFIED`: Type of the host is unspecified. Default value. `OPENSEARCH`: An OpenSearch type host. `DASHBOARDS`: A Dashboards type host.
health	enum Health Aggregated health of the host. If the field has default value, it is not returned in the response. `UNKNOWN`: Health of the host is unknown. Default value. `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 working below capacity or not fully functional.
subnet_id	string ID of the subnet that the host belongs to.
assign_public_ip	bool Determines whether a public IP is assigned to the host.
system	SystemMetrics Resources used by the host.
node_group	string Name of the host group that the host belongs to.
roles[]	enum GroupRole Roles of the host. `GROUP_ROLE_UNSPECIFIED` `DATA` `MANAGER`

Resources

A list of computational resources allocated to a host.

Field	Description
resource_preset_id	string ID of the preset for computational resources allocated to a host.
disk_size	int64 Volume of the storage used by the host, in bytes.
disk_type_id	string Type of the storage used by the host: `network-hdd`, `network-ssd` or `local-ssd`.

SystemMetrics

Resources used by the host.

Field	Description
cpu	CPUMetric CPU usage of the host.
memory	MemoryMetric RAM usage of the host.
disk	DiskMetric 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.

Managed Service for OpenSearch API, gRPC: ClusterService.ListHosts

gRPC requestgRPC request

ListClusterHostsRequestListClusterHostsRequest

ListClusterHostsResponseListClusterHostsResponse

HostHost

ResourcesResources

SystemMetricsSystemMetrics

CPUMetricCPUMetric

MemoryMetricMemoryMetric

DiskMetricDiskMetric

Была ли статья полезна?