Compute Cloud API, REST: ReservedInstancePool.Create

Written by

Updated at October 30, 2025

HTTP request
Body parameters
ResourcesSpec
GpuSettings
BootDiskSpec
ProductIDs
NetworkSettings
Response
CreateReservedInstancePoolMetadata
Status
ReservedInstancePool
ResourcesSpec
GpuSettings
NetworkSettings
SlotStats
InstanceStats

Creates an reserved instance pool in the specified folder.
Method starts an asynchronous operation that can be cancelled while it is in progress.

HTTP request

POST https://compute.api.cloud.yandex.net/compute/v1/reservedInstancePools

Body parameters

{
  "name": "string",
  "description": "string",
  "labels": "object",
  "zoneId": "string",
  "folderId": "string",
  "platformId": "string",
  "resourcesSpec": {
    "memory": "string",
    "cores": "string",
    "coreFraction": "string",
    "gpus": "string"
  },
  "gpuSettings": {
    "gpuClusterId": "string"
  },
  "bootDiskSpec": {
    // Includes only one of the fields `diskId`, `imageId`, `snapshotId`, `productIds`
    "diskId": "string",
    "imageId": "string",
    "snapshotId": "string",
    "productIds": {
      "productIds": [
        "string"
      ]
    }
    // end of the list of possible fields
  },
  "networkSettings": {
    "type": "string"
  },
  "size": "string",
  "allowOversubscription": "boolean"
}

Field	Description
name	string Name of the reserved instance pool.
description	string Description of the reserved instance pool.
labels	object (map<string, string>) Resource labels as `key:value` pairs.
zoneId	string Required field. ID of the availability zone where the reserved instance pool resides. To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request
folderId	string Required field. ID of the folder to create the reserved instance pool in. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request.
platformId	string Required field. ID of the hardware platform configuration for the reserved instance pool. This field affects the available values in `resourcesSpec` field. For more information, see Platforms.
resourcesSpec	ResourcesSpec Required field. Computing resources of the reserved instance pool instances, such as the amount of memory and number of cores. To get a list of available values, see Levels of core performance.
gpuSettings	GpuSettings GPU settings.
bootDiskSpec	BootDiskSpec Spec is used to determine which License IDs should be allowed for instances created in the pool.
networkSettings	NetworkSettings Network settings.
size	string (int64) Desired size of the pool (number of slots for instances in this 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.

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.

BootDiskSpec

Specification used to determine required product_ids
You can specify product ids explicitly or use disk_id|image_id|snapshot_id to infer products ids from them.

Field	Description
diskId	string Disk ID. Includes only one of the fields `diskId`, `imageId`, `snapshotId`, `productIds`.
imageId	string Image ID. Includes only one of the fields `diskId`, `imageId`, `snapshotId`, `productIds`.
snapshotId	string Snapshot ID. Includes only one of the fields `diskId`, `imageId`, `snapshotId`, `productIds`.
productIds	ProductIDs Product IDs. Includes only one of the fields `diskId`, `imageId`, `snapshotId`, `productIds`.

ProductIDs

Field

Description

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

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

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

CreateReservedInstancePoolMetadata

Field

Description

reservedInstancePoolId

string

ID of the reserved instance pool that is being created.

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

Compute Cloud API, REST: ReservedInstancePool.Create

HTTP requestHTTP request

Body parametersBody parameters

ResourcesSpecResourcesSpec

GpuSettingsGpuSettings

BootDiskSpecBootDiskSpec

ProductIDsProductIDs

NetworkSettingsNetworkSettings

ResponseResponse

CreateReservedInstancePoolMetadataCreateReservedInstancePoolMetadata

StatusStatus

ReservedInstancePoolReservedInstancePool

ResourcesSpecResourcesSpec

GpuSettingsGpuSettings

NetworkSettingsNetworkSettings

SlotStatsSlotStats

InstanceStatsInstanceStats

Was the article helpful?

HTTP request

Body parameters

ResourcesSpec

GpuSettings

BootDiskSpec

ProductIDs

NetworkSettings

Response

CreateReservedInstancePoolMetadata

Status

ReservedInstancePool

ResourcesSpec

GpuSettings

NetworkSettings

SlotStats

InstanceStats