Method list
Retrieves a list of subclusters in the specified cluster.
HTTP request
GET https://dataproc.api.cloud.yandex.net/dataproc/v1/clusters/{clusterId}/subclusters
Path parameters
| Parameter | Description |
|---|---|
| clusterId | Required. ID of the Data Proc cluster to list subclusters in. 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 page_token to the nextPageToken returned by a previous list request. The maximum string length in characters is 100. |
| filter | A filter expression that filters subclusters listed in the response. The expression must specify: 1. The field name. Currently you can use filtering only on Subcluster.name field. 2. An = operator. 3. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9]. Example of a filter: name=dataproc123_subcluster456. The maximum string length in characters is 1000. |
Response
HTTP Code: 200 - OK
{
"subclusters": [
{
"id": "string",
"clusterId": "string",
"createdAt": "string",
"name": "string",
"role": "string",
"resources": {
"resourcePresetId": "string",
"diskTypeId": "string",
"diskSize": "string"
},
"subnetId": "string",
"hostsCount": "string",
"assignPublicIp": true,
"autoscalingConfig": {
"maxHostsCount": "string",
"preemptible": true,
"measurementDuration": "string",
"warmupDuration": "string",
"stabilizationDuration": "string",
"cpuUtilizationTarget": "number",
"decommissionTimeout": "string"
},
"instanceGroupId": "string"
}
],
"nextPageToken": "string"
}
| Field | Description |
|---|---|
| subclusters[] | object A Data Proc subcluster. For details about the concept, see documentation. |
| subclusters[]. id |
string ID of the subcluster. Generated at creation time. |
| subclusters[]. clusterId |
string ID of the Data Proc cluster that the subcluster belongs to. |
| subclusters[]. createdAt |
string (date-time) Creation timestamp. String in RFC3339 text format. |
| subclusters[]. name |
string Name of the subcluster. The name is unique within the cluster. The string length in characters must be 1-63. |
| subclusters[]. role |
string Role that is fulfilled by hosts of the subcluster.
Master can run the following services, depending on the requested components:
DATANODE can run the following services, depending on the requested components:
COMPUTENODE can run the following services, depending on the requested components:
|
| subclusters[]. resources |
object Resources allocated for each host in the subcluster. |
| subclusters[]. resources. resourcePresetId |
string ID of the resource preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation. |
| subclusters[]. resources. diskTypeId |
string Type of the storage environment for the host. Possible values:
|
| subclusters[]. resources. diskSize |
string (int64) Volume of the storage available to a host, in bytes. |
| subclusters[]. subnetId |
string ID of the VPC subnet used for hosts in the subcluster. |
| subclusters[]. hostsCount |
string (int64) Number of hosts in the subcluster. |
| subclusters[]. assignPublicIp |
boolean (boolean) Assign public ip addresses for all hosts in subcluter. |
| subclusters[]. autoscalingConfig |
object Configuration for instance group based subclusters |
| subclusters[]. autoscalingConfig. maxHostsCount |
string (int64) Upper limit for total instance subcluster count. Acceptable values are 1 to 100, inclusive. |
| subclusters[]. autoscalingConfig. preemptible |
boolean (boolean) Preemptible instances are stopped at least once every 24 hours, and can be stopped at any time if their resources are needed by Compute. For more information, see Preemptible Virtual Machines. |
| subclusters[]. autoscalingConfig. measurementDuration |
string Required. Time in seconds allotted for averaging metrics. Acceptable values are 60 seconds to 600 seconds, inclusive. |
| subclusters[]. autoscalingConfig. warmupDuration |
string The warmup time of the instance in seconds. During this time, traffic is sent to the instance, but instance metrics are not collected. The maximum value is 600 seconds. |
| subclusters[]. autoscalingConfig. stabilizationDuration |
string Minimum amount of time in seconds allotted for monitoring before Instance Groups can reduce the number of instances in the group. During this time, the group size doesn't decrease, even if the new metric values indicate that it should. Acceptable values are 60 seconds to 1800 seconds, inclusive. |
| subclusters[]. autoscalingConfig. cpuUtilizationTarget |
number (double) Defines an autoscaling rule based on the average CPU utilization of the instance group. Acceptable values are 10 to 100, inclusive. |
| subclusters[]. autoscalingConfig. decommissionTimeout |
string (int64) Timeout to gracefully decommission nodes during downscaling. In seconds. Default value: 120 Acceptable values are 0 to 86400, inclusive. |
| subclusters[]. instanceGroupId |
string ID of Compute Instance Group for autoscaling subclusters |
| 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 |