Managed Service for Greenplum® API, REST: Cluster.listSegmentHosts
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
Parameter | Description |
---|---|
clusterId | Required. ID of the Greenplum® cluster. To get the Greenplum® 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",
"type": "string",
"resources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
},
"health": "string",
"subnetId": "string",
"assignPublicIp": true
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
hosts[] | object Requested list of hosts for the cluster. |
hosts[]. name |
string Required. 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. The maximum string length in characters is 63. |
hosts[]. clusterId |
string ID of the Greenplum® cluster. The ID is assigned by the platform at creation time. |
hosts[]. zoneId |
string ID of the availability zone the Greenplum® host belongs to. |
hosts[]. type |
string Type of the host. If the field has default value, it is not returned in the response.
|
hosts[]. resources |
object Resources allocated to the Greenplum® host. |
hosts[]. resources. resourcePresetId |
string ID of the preset for computational resources allocated to a host. Available presets are listed in the documentation. |
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[]. 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. |
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. |