Compute Cloud API, REST: ReservedInstancePool.List

Field

Description

folderId

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.

pageSize

string (int64)

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

pageToken

string

Page token. To get the next page of results,
set pageToken to the ListReservedInstancePoolsResponse.nextPageToken
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).

orderBy

string

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

Field

Description

reservedInstancePools[]

ReservedInstancePool

List of reserved instance pool resources.

nextPageToken

string

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

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

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.

Field

Description

gpuClusterId

string

Attach instance to specified GPU cluster.

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

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

Field

Description

total

string (int64)

Total number of instances linked to the pool