Method listHosts
Retrieves a list of hosts for the specified cluster.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/{clusterId}/hosts
Path parameters
| Parameter | Description |
|---|---|
| clusterId | Required. ID of the ClickHouse cluster. To get the ClickHouse 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 a 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",
"services": [
{
"type": "string",
"health": "string"
}
],
"subnetId": "string",
"assignPublicIp": true,
"shardName": "string"
}
],
"nextPageToken": "string"
}
| Field | Description |
|---|---|
| hosts[] | object Requested list of hosts for the cluster. |
| hosts[]. name |
string Name of the ClickHouse host. The host name is assigned by MDB at creation time, and cannot be changed. 1-63 characters long. The name is unique across all existing MDB hosts in Yandex.Cloud, as it defines the FQDN of the host. |
| hosts[]. clusterId |
string ID of the ClickHouse host. The ID is assigned by MDB at creation time. |
| hosts[]. zoneId |
string ID of the availability zone where the ClickHouse host resides. |
| hosts[]. type |
string Type of the host.
|
| hosts[]. resources |
object Resources allocated to the ClickHouse host. |
| hosts[]. resources. resourcePresetId |
string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation |
| hosts[]. resources. diskSize |
string (int64) Volume of the storage available to a host, in bytes. |
| hosts[]. resources. diskTypeId |
string Type of the storage environment for the host. Possible values:
|
| hosts[]. health |
string Status code of the aggregated health of the host.
|
| hosts[]. services[] |
object Services provided by the host. |
| hosts[]. services[]. type |
string Type of the service provided by the host.
|
| hosts[]. services[]. health |
string Status code of server availability.
|
| hosts[]. subnetId |
string ID of the subnet that the host belongs to. |
| hosts[]. assignPublicIp |
boolean (boolean) Flag showing public IP assignment status to this host. |
| hosts[]. shardName |
string |
| 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 will have its own nextPageToken to continue paging through the results. |