Managed Service for Apache Kafka® API, gRPC: ClusterService.ListHosts

Field

Description

cluster_id

string

Required field. ID of the Apache Kafka® cluster.
To get the Apache Kafka® cluster ID, make a ClusterService.List request.

The maximum string length in characters is 50.

page_size

int64

The maximum number of results per page to return.
If the number of available results is larger than page_size, the service returns a ListClusterHostsResponse.next_page_token that can be used to get the next page of results in subsequent list requests.

The maximum value is 1000.

page_token

string

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

The maximum string length in characters is 100.

Field

Description

hosts[]

Host

List of hosts.

next_page_token

string

Token that 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 next_page_token as the value for the ListClusterHostsRequest.page_token query parameter in the next list request.
Each subsequent list request will have its own next_page_token to continue paging through the results.

Field

Description

name

string

Name of the host.

cluster_id

string

ID of the Apache Kafka® cluster.

zone_id

string

ID of the availability zone where the host resides.

role

enum Role

Host role. If the field has default value, it is not returned in the response.

• KAFKA: The host is a Kafka broker.
• ZOOKEEPER: The host is a ZooKeeper server.
• KRAFT: The host is a Kafka KRaft controller broker.

resources

Resources

Computational resources allocated to the host.

health

enum Health

Aggregated host health data. 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 degraded and can perform only some of its essential functions.

subnet_id

string

ID of the subnet the host resides in.

assign_public_ip

bool

The flag that defines whether a public IP address is assigned to the node.
If the value is true, then this node is available on the Internet via it's public IP address.

Field

Description

resource_preset_id

string

ID of the preset for computational resources available to a host (CPU, memory, etc.).
All available presets are listed in the documentation.

disk_size

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.

disk_type_id

string

Type of the storage environment for the host.