Method update
Updates the specified subcluster.
HTTP request
PATCH https://dataproc.api.cloud.yandex.net/dataproc/v1/clusters/{clusterId}/subclusters/{subclusterId}
Path parameters
| Parameter | Description |
|---|---|
| clusterId | Required. ID of the cluster to update a subcluster in. To get a cluster ID, make a list request. The maximum string length in characters is 50. |
| subclusterId | Required. ID of the subcluster to update. To get a subcluster ID, make a list request. The maximum string length in characters is 50. |
Body parameters
{
"updateMask": "string",
"resources": {
"resourcePresetId": "string",
"diskTypeId": "string",
"diskSize": "string"
},
"name": "string",
"hostsCount": "string",
"decommissionTimeout": "string",
"autoscalingConfig": {
"maxHostsCount": "string",
"preemptible": true,
"measurementDuration": "string",
"warmupDuration": "string",
"stabilizationDuration": "string",
"cpuUtilizationTarget": "number",
"decommissionTimeout": "string"
}
}
| Field | Description |
|---|---|
| updateMask | string Field mask that specifies which attributes of the subcluster should be updated. A comma-separated names off ALL fields to be updated. Оnly the specified fields will be changed. The others will be left untouched. If the field is specified in If |
| resources | object New configuration of resources that should be allocated for each host in the subcluster. |
| 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. |
| resources. diskTypeId |
string Type of the storage environment for the host. Possible values:
|
| resources. diskSize |
string (int64) Volume of the storage available to a host, in bytes. |
| name | string New name for the subcluster. The name must be unique within the cluster. Value must match the regular expression |
| hostsCount | string (int64) Required. New number of hosts in the subcluster. The minimum value is 1. |
| decommissionTimeout | string (int64) Timeout to gracefully decommission nodes. In seconds. Default value: 0 Acceptable values are 0 to 86400, inclusive. |
| autoscalingConfig | object Configuration for instance group based subclusters |
| autoscalingConfig. maxHostsCount |
string (int64) Upper limit for total instance subcluster count. Acceptable values are 1 to 100, inclusive. |
| 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. |
| autoscalingConfig. measurementDuration |
string Required. Time in seconds allotted for averaging metrics. Acceptable values are 60 seconds to 600 seconds, inclusive. |
| 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. |
| 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. |
| 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. |
| autoscalingConfig. decommissionTimeout |
string (int64) Timeout to gracefully decommission nodes during downscaling. In seconds. Default value: 120 Acceptable values are 0 to 86400, inclusive. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": true,
"metadata": "object",
// includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": "object",
// 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 text format. |
| 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 text format. |
| done | boolean (boolean) If the value is |
| metadata | object Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
| error | object The error result of the operation in case of failure or cancellation. includes only one of the fields error, responseThe error result of the operation in case of failure or cancellation. |
| error. code |
integer (int32) Error code. An enum value of google.rpc.Code. |
| error. message |
string An error message. |
| error. details[] |
object A list of messages that carry the error details. |
| response | object includes only one of the fields error, responseThe normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. |