Data Proc API, REST: Subcluster.Get
Returns the specified subcluster.
To get the list of all available subclusters, make a SubclusterService.List request.
HTTP request
GET https://dataproc.api.cloud.yandex.net/dataproc/v1/clusters/{clusterId}/subclusters/{subclusterId}
Path parameters
Field |
Description |
clusterId |
string Required field. ID of the Data Proc cluster that the subcluster belongs to. |
subclusterId |
string Required field. ID of the subcluster to return. To get a subcluster ID make a SubclusterService.List request. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"clusterId": "string",
"createdAt": "string",
"name": "string",
"role": "string",
"resources": {
"resourcePresetId": "string",
"diskTypeId": "string",
"diskSize": "string"
},
"subnetId": "string",
"hostsCount": "string",
"assignPublicIp": "boolean",
"autoscalingConfig": {
"maxHostsCount": "string",
"preemptible": "boolean",
"measurementDuration": "string",
"warmupDuration": "string",
"stabilizationDuration": "string",
"cpuUtilizationTarget": "string",
"decommissionTimeout": "string"
},
"instanceGroupId": "string"
}
A Data Proc subcluster. For details about the concept, see documentation.
Field |
Description |
id |
string ID of the subcluster. Generated at creation time. |
clusterId |
string ID of the Data Proc cluster that the subcluster belongs to. |
createdAt |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
name |
string Name of the subcluster. The name is unique within the cluster. |
role |
enum (Role) Role that is fulfilled by hosts of the subcluster.
|
resources |
Resources allocated for each host in the subcluster. |
subnetId |
string ID of the VPC subnet used for hosts in the subcluster. |
hostsCount |
string (int64) Number of hosts in the subcluster. |
assignPublicIp |
boolean Assign public ip addresses for all hosts in subcluter. |
autoscalingConfig |
Configuration for instance group based subclusters |
instanceGroupId |
string ID of Compute Instance Group for autoscaling subclusters |
Resources
Field |
Description |
resourcePresetId |
string ID of the resource preset for computational resources available to a host (CPU, memory etc.). |
diskTypeId |
string Type of the storage environment for the host.
|
diskSize |
string (int64) Volume of the storage available to a host, in bytes. |
AutoscalingConfig
Field |
Description |
maxHostsCount |
string (int64) Upper limit for total instance subcluster count. |
preemptible |
boolean Preemptible instances are stopped at least once every 24 hours, and can be stopped at any time |
measurementDuration |
string (duration) Required field. Time in seconds allotted for averaging metrics. |
warmupDuration |
string (duration) The warmup time of the instance in seconds. During this time, |
stabilizationDuration |
string (duration) Minimum amount of time in seconds allotted for monitoring before |
cpuUtilizationTarget |
string Defines an autoscaling rule based on the average CPU utilization of the instance group. |
decommissionTimeout |
string (int64) Timeout to gracefully decommission nodes during downscaling. In seconds. Default value: 120 |