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

Compute Cloud API, gRPC: ReservedInstancePoolService.List

Written by
Updated at August 8, 2025

Retrieves the list of reserved instance pool resources in the specified folder.

gRPC request

rpc List (ListReservedInstancePoolsRequest) returns (ListReservedInstancePoolsResponse)

ListReservedInstancePoolsRequest

{
  "folder_id": "string",
  "page_size": "int64",
  "page_token": "string",
  "filter": "string",
  "order_by": "string"
}

Field

Description

folder_id

string

Required field. ID of the Folder to list reserved instance pools in.
To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request.

page_size

int64

The maximum number of results per page to return. If the number of available
results is larger than page_size,
the service returns a ListReservedInstancePoolsResponse.next_page_token
that can be used to get the next page of results in subsequent list requests.

page_token

string

Page token. To get the next page of results,
set page_token to the ListReservedInstancePoolsResponse.next_page_token
returned by a previous list request.

filter

string

A filter expression that filters resources listed in the response.
The expression consists of one or more conditions united by AND operator: <condition1> [AND <condition2> [<...> AND <conditionN>]].

Each condition has the form <field> <operator> <value>, where:

  1. <field> is the field name. Currently you can use filtering only on the limited number of fields.
  2. <operator> is a logical operator, one of =, !=, IN, NOT IN.
  3. <value> represents a value.
    String values should be written in double (") or single (') quotes. C-style escape sequences are supported (\" turns to ", \' to ', \\ to backslash).

order_by

string

By which column the listing should be ordered and in which direction,
format is "createdAt desc". "id asc" if omitted.

ListReservedInstancePoolsResponse

{
  "reserved_instance_pools": [
    {
      "id": "string",
      "zone_id": "string",
      "cloud_id": "string",
      "folder_id": "string",
      "name": "string",
      "description": "string",
      "labels": "map<string, string>",
      "created_at": "google.protobuf.Timestamp",
      "platform_id": "string",
      "resources_spec": {
        "memory": "int64",
        "cores": "int64",
        "core_fraction": "int64",
        "gpus": "int64"
      },
      "gpu_settings": {
        "gpu_cluster_id": "string"
      },
      "product_ids": [
        "string"
      ],
      "network_settings": {
        "type": "Type"
      },
      "size": "int64",
      "committed_size": "int64",
      "allow_oversubscription": "bool",
      "slot_stats": {
        "total": "int64",
        "used": "int64",
        "available": "int64",
        "unavailable": "int64",
        "pending": "int64"
      },
      "instance_stats": {
        "total": "int64"
      }
    }
  ],
  "next_page_token": "string"
}

Field

Description

reserved_instance_pools[]

ReservedInstancePool

List of reserved instance pool resources.

next_page_token

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListReservedInstancePoolsRequest.page_size, use
the next_page_token as the value
for the ListReservedInstancePoolsRequest.page_token query parameter
in the next list request. Each subsequent list request will have its own
next_page_token to continue paging through the results.

ReservedInstancePool

A Reserved Instance Pool resource.

Field

Description

id

string

ID of the pool.

zone_id

string

ID of the availability zone where the pool resides.

cloud_id

string

ID of the cloud that the pool belongs to.

folder_id

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.

created_at

google.protobuf.Timestamp

platform_id

string

ID of the hardware platform configuration for pool instances.

resources_spec

ResourcesSpec

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

gpu_settings

GpuSettings

GPU settings.

product_ids[]

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.

network_settings

NetworkSettings

Network Settings.

size

int64

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

committed_size

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.

allow_oversubscription

bool

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.

slot_stats

SlotStats

Statuses of the pool slots

instance_stats

InstanceStats

Stats for instances of the pool

ResourcesSpec

Field

Description

memory

int64

Required field. The amount of memory available to the instance, specified in bytes.

cores

int64

Required field. The number of cores available to the instance.

core_fraction

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

int64

The number of GPUs available to the instance.

GpuSettings

Field

Description

gpu_cluster_id

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

int64

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

used

int64

Number of slots used by running instances

available

int64

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

unavailable

int64

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

pending

int64

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

InstanceStats

Field

Description

total

int64

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