Contact UsGet started

Managed Service for Greenplum® API, REST: Cluster.ListSegmentHosts

Written by
Updated at November 26, 2024

Retrieves a list of segment hosts for the specified cluster.

HTTP request

GET https://mdb.api.cloud.yandex.net/managed-greenplum/v1/clusters/{clusterId}/segment-hosts

Path parameters

Field

Description

clusterId

string

Required field. ID of the Greenplum® cluster.

To get the Greenplum® cluster ID use a ClusterService.List request.

Query parameters

Field

Description

pageSize

string (int64)

The maximum number of results per page to return.

If the number of available results is larger than pageSize, the service returns a ListClusterHostsResponse.nextPageToken that can be used to get the next page of results in subsequent list requests.

pageToken

string

Page token. To get the next page of results, set pageToken to the ListClusterHostsResponse.nextPageToken returned by the previous list request.

Response

HTTP Code: 200 - OK

{
  "hosts": [
    {
      "name": "string",
      "clusterId": "string",
      "zoneId": "string",
      "type": "string",
      "resources": {
        "resourcePresetId": "string",
        "diskSize": "string",
        "diskTypeId": "string"
      },
      "health": "string",
      "subnetId": "string",
      "assignPublicIp": "boolean"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

hosts[]

Host

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 nextPageToken as the value for the ListClusterHostsRequest.pageToken query parameter in the next list request.

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

Host

A Greenplum® cluster host resource.

Field

Description

name

string

Required field. Name of the Greenplum® 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

ID of the Greenplum® cluster. The ID is assigned by the platform at creation time.

zoneId

string

ID of the availability zone the Greenplum® host belongs to.

type

enum (Type)

Type of the host. If the field has default value, it is not returned in the response.

  • TYPE_UNSPECIFIED: Host type is not specified. Default value.
  • MASTER: A Greenplum® master host.
  • REPLICA: A Greenplum® master replica host.
  • SEGMENT: A Greenplum® segment host.

resources

Resources

Resources allocated to the Greenplum® 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.
  • UNBALANCED: One or more segments are not in the preferred role.

subnetId

string

ID of the subnet that the host belongs to.

assignPublicIp

boolean

Determines whether a public IP is assigned to the host.

Resources

Field

Description

resourcePresetId

string

ID of the preset for computational resources allocated to a host.

Available presets are listed in the documentation.

diskSize

string (int64)

Volume of the storage used by the host, in bytes.

diskTypeId

string

Type of the storage used by the host: network-hdd, network-ssd or local-ssd.
Previous
ListMasterHosts
Next
ListLogs