Data Proc API, REST: Subcluster.Update
Updates the specified subcluster.
HTTP request
PATCH https://dataproc.api.cloud.yandex.net/dataproc/v1/clusters/{clusterId}/subclusters/{subclusterId}
Path parameters
Field |
Description |
clusterId |
string Required field. ID of the cluster to update a subcluster in. To get a cluster ID, make a ClusterService.List request. |
subclusterId |
string Required field. ID of the subcluster to update. To get a subcluster ID, make a SubclusterService.List request. |
Body parameters
{
"updateMask": "string",
"resources": {
"resourcePresetId": "string",
"diskTypeId": "string",
"diskSize": "string"
},
"name": "string",
"hostsCount": "string",
"decommissionTimeout": "string",
"autoscalingConfig": {
"maxHostsCount": "string",
"preemptible": "boolean",
"measurementDuration": "string",
"warmupDuration": "string",
"stabilizationDuration": "string",
"cpuUtilizationTarget": "string",
"decommissionTimeout": "string"
}
}
Field |
Description |
updateMask |
string (field-mask) A comma-separated names off ALL fields to be updated. If |
resources |
New configuration of resources that should be allocated for each host in the subcluster. |
name |
string New name for the subcluster. The name must be unique within the cluster. |
hostsCount |
string (int64) Required field. New number of hosts in the subcluster. |
decommissionTimeout |
string (int64) Timeout to gracefully decommission nodes. In seconds. Default value: 0 |
autoscalingConfig |
Configuration for instance group based 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 |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"clusterId": "string",
"subclusterId": "string"
},
// Includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": {
"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"
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field |
Description |
id |
string ID of the operation. |
description |
string Description of the operation. 0-256 characters long. |
createdAt |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
string (date-time) The time when the Operation resource was last modified. String in RFC3339 To work with values in this field, use the APIs described in the |
done |
boolean If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
UpdateSubclusterMetadata
Field |
Description |
clusterId |
string ID of the cluster whose subcluster is being updated. |
subclusterId |
string ID of the subcluster that is being updated. |
Status
The error result of the operation in case of failure or cancellation.
Field |
Description |
code |
integer (int32) Error code. An enum value of google.rpc.Code |
message |
string An error message. |
details[] |
object A list of messages that carry the error details. |
Subcluster
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 |