Compute Cloud API, REST: ReservedInstancePool.Update
Updates the specified reserved instance pool.
HTTP request
PATCH https://compute.api.cloud.yandex.net/compute/v1/reservedInstancePools/{reservedInstancePoolId}
Path parameters
Field |
Description |
reservedInstancePoolId |
string Required field. ID of the reserved instance pool to update. |
Body parameters
{
"updateMask": "string",
"name": "string",
"description": "string",
"labels": "object",
"size": "string"
}
Field |
Description |
updateMask |
string (field-mask) A comma-separated names off ALL fields to be updated. If |
name |
string New name for the reserved instance pool. |
description |
string Description of the reserved instance pool. |
labels |
object (map<string, string>) Resource labels as Existing set of |
size |
string (int64) Desired size of the pool. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"reservedInstancePoolId": "string"
},
// Includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": {
"id": "string",
"zoneId": "string",
"cloudId": "string",
"folderId": "string",
"name": "string",
"description": "string",
"labels": "object",
"createdAt": "string",
"platformId": "string",
"resourcesSpec": {
"memory": "string",
"cores": "string",
"coreFraction": "string",
"gpus": "string"
},
"gpuSettings": {
"gpuClusterId": "string"
},
"productIds": [
"string"
],
"networkSettings": {
"type": "string"
},
"size": "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 |
UpdateReservedInstancePoolMetadata 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. |
UpdateReservedInstancePoolMetadata
Field |
Description |
reservedInstancePoolId |
string ID of the reserved instance pool 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. |
ReservedInstancePool
A Reserved Instance Pool resource.
Field |
Description |
id |
string ID of the pool. |
zoneId |
string ID of the availability zone where the pool resides. |
cloudId |
string ID of the cloud that the pool belongs to. |
folderId |
string ID of the folder that the pool belongs to. |
name |
string Name of the pool. 1-63 characters long. |
description |
string Description of the pool. 0-256 characters long. |
labels |
object (map<string, string>) Resource labels as |
createdAt |
string (date-time) String in RFC3339 To work with values in this field, use the APIs described in the |
platformId |
string ID of the hardware platform configuration for pool instances. |
resourcesSpec |
Computing resources of pool instances, such as the amount of memory and number of cores. |
gpuSettings |
GPU settings. |
productIds[] |
string License IDs that indicate which licenses are attached to resource. |
networkSettings |
Network Settings. |
size |
string (int64) Desired size of the pool (number of slots for instances in this pool). |
ResourcesSpec
Field |
Description |
memory |
string (int64) Required field. The amount of memory available to the instance, specified in bytes. |
cores |
string (int64) Required field. The number of cores available to the instance. |
coreFraction |
string (int64) Baseline level of CPU performance with the ability to burst performance above that baseline level. For example, if you need only 5% of the CPU performance, you can set core_fraction=5. |
gpus |
string (int64) The number of GPUs available to the instance. |
GpuSettings
Field |
Description |
gpuClusterId |
string Attach instance to specified GPU cluster. |
NetworkSettings
Field |
Description |
type |
enum (Type) Network Type
|