Managed Service for Greenplum® API, gRPC: ClusterService.ListSegmentHosts
Retrieves a list of segment hosts for the specified cluster.
gRPC request
rpc ListSegmentHosts (ListClusterHostsRequest) returns (ListClusterHostsResponse)
ListClusterHostsRequest
{
"cluster_id": "string",
"page_size": "int64",
"page_token": "string"
}
|
Field |
Description |
|
cluster_id |
string Required field. ID of the Greenplum® cluster. To get the Greenplum® 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_token |
string Page token. To get the next page of results, set |
ListClusterHostsResponse
{
"hosts": [
{
"name": "string",
"cluster_id": "string",
"zone_id": "string",
"type": "Type",
"resources": {
"resource_preset_id": "string",
"disk_size": "int64",
"disk_type_id": "string"
},
"health": "Health",
"subnet_id": "string",
"assign_public_ip": "bool"
}
],
"next_page_token": "string"
}
|
Field |
Description |
|
hosts[] |
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 Each subsequent list request has its own |
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. |
|
cluster_id |
string ID of the Greenplum® cluster. The ID is assigned by the platform at creation time. |
|
zone_id |
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.
|
|
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.
|
|
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. |
Resources
|
Field |
Description |
|
resource_preset_id |
string ID of the preset for computational resources allocated to a host. Available presets are listed in the documentation. |
|
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: |