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
Parameter | Description |
---|---|
clusterId | ID of the cluster to list hosts for. To get a 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. Default value: 100. 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. |
filter | A filter expression that filters hosts listed in the response. The expression must specify:
The maximum string length in characters is 1000. |
Response
HTTP Code: 200 - OK
{
"hosts": [
{
"name": "string",
"subclusterId": "string",
"health": "string",
"computeInstanceId": "string",
"role": "string"
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
hosts[] | object Requested list of hosts. |
hosts[]. name |
string Name of the Data Proc host. The host name is assigned by Data Proc at creation time and cannot be changed. The name is generated to be unique across all Data Proc hosts that exist on the platform, as it defines the FQDN of the host. |
hosts[]. subclusterId |
string ID of the Data Proc subcluster that the host belongs to. |
hosts[]. health |
string Status code of the aggregated health of the host.
|
hosts[]. computeInstanceId |
string ID of the Compute virtual machine that is used as the Data Proc host. |
hosts[]. role |
string Role of the host in the cluster.
|
nextPageToken | string Token for getting the next page of the list. If the number of results is greater than the specified pageSize, use Each subsequent page will have its own |