Data Proc API, REST: Cluster.ListHosts
Retrieves the list of hosts in the specified cluster.
HTTP request
GET https://dataproc.api.cloud.yandex.net/dataproc/v1/clusters/{clusterId}/hosts
Path parameters
Field |
Description |
clusterId |
string Required field. ID of the cluster to list hosts for. To get a cluster ID, make a ClusterService.List request. |
Query parameters
Field |
Description |
pageSize |
string (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:
|
Response
HTTP Code: 200 - OK
{
"hosts": [
{
"name": "string",
"subclusterId": "string",
"health": "string",
"computeInstanceId": "string",
"role": "string"
}
],
"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.
|