Managed Service for Apache Kafka® API, REST: Cluster.listHosts
Retrieves a list of hosts for the specified Apache Kafka® cluster.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters/{clusterId}/hosts
Path parameters
Parameter | Description |
---|---|
clusterId | Required. ID of the Apache Kafka® cluster. To get the Apache Kafka® cluster ID, make 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",
"role": "string",
"resources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
},
"health": "string",
"subnetId": "string",
"assignPublicIp": true
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
hosts[] | object List of hosts. |
hosts[]. name |
string Name of the host. |
hosts[]. clusterId |
string ID of the Apache Kafka® cluster. |
hosts[]. zoneId |
string ID of the availability zone where the host resides. |
hosts[]. role |
string Host role. If the field has default value, it is not returned in the response.
|
hosts[]. resources |
object Computational resources allocated to the 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. Must be greater than 2 * partition segment size in bytes * partitions count, so each partition can have one active segment file and one closed segment file that can be deleted. |
hosts[]. resources. diskTypeId |
string Type of the storage environment for the host. |
hosts[]. health |
string Aggregated host health data. If the field has default value, it is not returned in the response.
|
hosts[]. subnetId |
string ID of the subnet the host resides in. |
hosts[]. assignPublicIp |
boolean (boolean) The flag that defines whether a public IP address is assigned to the node. If the value is |
nextPageToken | string Token that 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. |