Compute Cloud API, REST: GpuCluster.Update
Updates the specified GPU cluster.
Currently only name, description and labels can be updated.
HTTP request
PATCH https://compute.api.cloud.yandex.net/compute/v1/gpuClusters/{gpuClusterId}
Path parameters
Field |
Description |
gpuClusterId |
string Required field. ID of the GPU cluster to update. To get the GPU cluster ID, make a GpuClusterService.List request. |
Body parameters
{
"updateMask": "string",
"name": "string",
"description": "string",
"labels": "string"
}
Field |
Description |
updateMask |
string (field-mask) A comma-separated names off ALL fields to be updated. If |
name |
string New name for the GPU cluster. The name must be unique within the folder. |
description |
string New description of the GPU cluster. |
labels |
string New GPU cluster labels as Existing set of labels is completely replaced by the provided set, so if you just want
|
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"gpuClusterId": "string"
},
// Includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": {
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "string",
"status": "string",
"zoneId": "string",
"interconnectType": "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. |
UpdateGpuClusterMetadata
Field |
Description |
gpuClusterId |
string ID of the GPU cluster 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. |
GpuCluster
A GPU cluster. For details about the concept, see documentation.
Field |
Description |
id |
string ID of GPU cluster. |
folderId |
string ID of the folder that the GPU cluster 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 GPU cluster. The name is unique within the folder. |
description |
string Description of the GPU cluster. |
labels |
string GPU cluster labels as |
status |
enum (Status) Status of the GPU cluster.
|
zoneId |
string ID of the availability zone where the GPU cluster resides. |
interconnectType |
enum (GpuInterconnectType) Type of interconnect used for this GPU cluster.
|