Data Proc API, REST: Cluster.update
Updates the configuration of the specified cluster.
HTTP request
PATCH https://dataproc.api.cloud.yandex.net/dataproc/v1/clusters/{clusterId}
Path parameters
Parameter | Description |
---|---|
clusterId | ID of the cluster to update. To get the cluster ID, make a list request. The maximum string length in characters is 50. |
Body parameters
{
"updateMask": "string",
"description": "string",
"labels": "object",
"configSpec": {
"subclustersSpec": [
{
"id": "string",
"name": "string",
"resources": {
"resourcePresetId": "string",
"diskTypeId": "string",
"diskSize": "string"
},
"hostsCount": "string",
"autoscalingConfig": {
"maxHostsCount": "string",
"preemptible": true,
"measurementDuration": "string",
"warmupDuration": "string",
"stabilizationDuration": "string",
"cpuUtilizationTarget": "number",
"decommissionTimeout": "string"
}
}
],
"hadoop": {
"services": [
"string"
],
"properties": "object",
"sshPublicKeys": [
"string"
],
"initializationActions": [
{
"uri": "string",
"args": [
"string"
],
"timeout": "string"
}
]
}
},
"name": "string",
"serviceAccountId": "string",
"bucket": "string",
"decommissionTimeout": "string",
"uiProxy": true,
"securityGroupIds": [
"string"
],
"deletionProtection": true,
"logGroupId": "string"
}
Field | Description |
---|---|
updateMask | string Field mask that specifies which attributes of the cluster should be updated. A comma-separated names off ALL fields to be updated. Only the specified fields will be changed. The others will be left untouched. If the field is specified in If |
description | string New description for the cluster. The maximum string length in characters is 256. |
labels | object A new set of cluster labels as No more than 64 per resource. The string length in characters for each key must be 1-63. Each key must match the regular expression |
configSpec | object Configuration and resources for hosts that should be created with the Data Proc cluster. |
configSpec. subclustersSpec[] |
object New configuration for subclusters in a cluster. |
configSpec. subclustersSpec[]. id |
string ID of the subcluster to update. To get the subcluster ID make a list request. |
configSpec. subclustersSpec[]. name |
string Name of the subcluster. Value must match the regular expression |
configSpec. subclustersSpec[]. resources |
object Resource configuration for each host in the subcluster. |
configSpec. subclustersSpec[]. 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. |
configSpec. subclustersSpec[]. resources. diskTypeId |
string Type of the storage environment for the host. Possible values:
|
configSpec. subclustersSpec[]. resources. diskSize |
string (int64) Volume of the storage available to a host, in bytes. |
configSpec. subclustersSpec[]. hostsCount |
string (int64) Number of hosts in the subcluster. The minimum value is 1. |
configSpec. subclustersSpec[]. autoscalingConfig |
object Configuration for instance group based subclusters |
configSpec. subclustersSpec[]. autoscalingConfig. maxHostsCount |
string (int64) Upper limit for total instance subcluster count. Acceptable values are 1 to 100, inclusive. |
configSpec. subclustersSpec[]. 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. |
configSpec. subclustersSpec[]. autoscalingConfig. measurementDuration |
string Required. Time in seconds allotted for averaging metrics. Acceptable values are 60 seconds to 600 seconds, inclusive. |
configSpec. subclustersSpec[]. 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. |
configSpec. subclustersSpec[]. 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. |
configSpec. subclustersSpec[]. autoscalingConfig. cpuUtilizationTarget |
number (double) Defines an autoscaling rule based on the average CPU utilization of the instance group. Acceptable values are 0 to 100, inclusive. |
configSpec. subclustersSpec[]. autoscalingConfig. decommissionTimeout |
string (int64) Timeout to gracefully decommission nodes during downscaling. In seconds. Default value: 120 Acceptable values are 0 to 86400, inclusive. |
configSpec. hadoop |
object Hadoop specific options Hadoop configuration that describes services installed in a cluster, their properties and settings. |
configSpec. hadoop. services[] |
string Set of services used in the cluster (if empty, the default set is used). |
configSpec. hadoop. properties |
object Properties set for all hosts in For example, use the key 'hdfs:dfs.replication' to set the |
configSpec. hadoop. sshPublicKeys[] |
string List of public SSH keys to access to cluster hosts. |
configSpec. hadoop. initializationActions[] |
object Set of init-actions |
configSpec. hadoop. initializationActions[]. uri |
string URI of the executable file |
configSpec. hadoop. initializationActions[]. args[] |
string Arguments to the initialization action |
configSpec. hadoop. initializationActions[]. timeout |
string (int64) Execution timeout |
name | string New name for the Data Proc cluster. The name must be unique within the folder. Value must match the regular expression |
serviceAccountId | string ID of the new service account to be used by the Data Proc manager agent. |
bucket | string Name of the new Object Storage bucket to use for Data Proc jobs. |
decommissionTimeout | string (int64) Timeout to gracefully decommission nodes. In seconds. Default value: 0 Acceptable values are 0 to 86400, inclusive. |
uiProxy | boolean (boolean) Enable UI Proxy feature. |
securityGroupIds[] | string User security groups. |
deletionProtection | boolean (boolean) Deletion Protection inhibits deletion of the cluster |
logGroupId | string ID of the cloud logging log group to write logs. If not set, logs will not be sent to logging service |
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. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
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. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
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 , response |
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 , response The 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. |