Data Proc API, gRPC: ClusterService.ListHosts
Retrieves the list of hosts in the specified cluster.
gRPC request
rpc ListHosts (ListClusterHostsRequest) returns (ListClusterHostsResponse)
ListClusterHostsRequest
{
"clusterId": "string",
"pageSize": "int64",
"pageToken": "string",
"filter": "string"
}
Field |
Description |
clusterId |
string ID of the cluster to list hosts for. To get a cluster ID, make a ClusterService.List request. |
pageSize |
int64 The maximum number of results per page to return. If the number of available |
pageToken |
string Page token. To get the next page of results, set |
filter |
string A filter expression that filters hosts listed in the response. The expression must specify:
|
ListClusterHostsResponse
{
"hosts": [
{
"name": "string",
"subclusterId": "string",
"health": "Health",
"computeInstanceId": "string",
"role": "Role"
}
],
"nextPageToken": "string"
}
Field |
Description |
hosts[] |
Requested list of hosts. |
nextPageToken |
string Token for getting the next page of the list. If the number of results is greater than Each subsequent page will have its own |
Host
A Data Proc host. For details about the concept, see documentation.
Field |
Description |
name |
string Name of the Data Proc host. The host name is assigned by Data Proc at creation time |
subclusterId |
string ID of the Data Proc subcluster that the host belongs to. |
health |
enum Health Status code of the aggregated health of the host.
|
computeInstanceId |
string ID of the Compute virtual machine that is used as the Data Proc host. |
role |
enum Role Role of the host in the cluster.
|