Contact UsGet started
© 2025 Direct Cursus Technology L.L.C.

Compute Cloud API, REST: ReservedInstancePool.Update

Written by
Updated at August 8, 2025

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.
To get the reserved instance pool ID, use a ReservedInstancePoolService.List request.

Body parameters

{
  "updateMask": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "size": "string",
  "allowOversubscription": "boolean",
  "allowPendingSlots": "boolean"
}

Field

Description

updateMask

string (field-mask)

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 updateMask and no value for that field was sent in the request,
the field's value will be reset to the default. The default value for most fields is null or 0.

If updateMask is not sent in the request, all fields' values will be updated.
Fields specified in the request will be updated to provided values.
The rest of the fields will be reset to the default.

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 key:value pairs.

Existing set of labels is completely replaced by the provided set.

size

string (int64)

Desired size of the pool.

allowOversubscription

boolean

Allows the pool to contain more linked instances than the number of available slots (size without pending or unavailable slots).
While running instances are still limited by available slots, stopped instances can exceed this limit.
Warning: When this option is enabled, attempting to start more instances than the number of available slots will result in a "Not Enough Resources" error.

allowPendingSlots

boolean

This field affects only the current request and allows size-increasing operation to complete successfully even when there are not enough resources.
In such cases, some of the new pool slots become "pending", meaning they cannot be used until resources become available.
Pending slots automatically convert to normal slots when sufficient resources are available.

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",
    "committedSize": "string",
    "allowOversubscription": "boolean",
    "slotStats": {
      "total": "string",
      "used": "string",
      "available": "string",
      "unavailable": "string",
      "pending": "string"
    },
    "instanceStats": {
      "total": "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 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

UpdateReservedInstancePoolMetadata

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

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

ReservedInstancePool

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.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

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 key:value pairs. Maximum of 64 per resource.

createdAt

string (date-time)

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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).

platformId

string

ID of the hardware platform configuration for pool instances.

resourcesSpec

ResourcesSpec

Computing resources of pool instances, such as the amount of memory and number of cores.

gpuSettings

GpuSettings

GPU settings.

productIds[]

string

License IDs that indicate which licenses are attached to resource.
License IDs are used to calculate additional charges for the use of the virtual machine.

networkSettings

NetworkSettings

Network Settings.

size

string (int64)

Desired size of the pool (number of slots for instances in this pool).

committedSize

string (int64)

Equals to the size field except when updates occur with allow_pending=true. In those cases, committed_size equals only the number of non-pending slots.

allowOversubscription

boolean

Allows the pool to contain more linked instances than the number of available slots (size without pending or unavailable slots).
While running instances are still limited by available slots, stopped instances can exceed this limit.
Warning: When this option is enabled, attempting to start more instances than the number of available slots will result in a "Not Enough Resources" error.

slotStats

SlotStats

Statuses of the pool slots

instanceStats

InstanceStats

Stats for instances of the 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.
This field sets baseline performance for each core.

For example, if you need only 5% of the CPU performance, you can set core_fraction=5.
For more information, see Levels of core performance.

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

  • TYPE_UNSPECIFIED
  • STANDARD: Standard network.
  • SOFTWARE_ACCELERATED: Software accelerated network.
  • HARDWARE_ACCELERATED: Hardware accelerated network (not available yet, reserved for future use).

SlotStats

Field

Description

total

string (int64)

Equals to pool size (and equals to the sum of the following fields)

used

string (int64)

Number of slots used by running instances

available

string (int64)

Number of slots available for instances (but not currently used)

unavailable

string (int64)

Number of slots unavailable for some reason (for example because of underlying host failure)

pending

string (int64)

Number of slots requested for async update, but still waiting for resources and not yet available for usage

InstanceStats

Field

Description

total

string (int64)

Total number of instances linked to the pool
Previous
Create
Next
Delete