Compute Cloud API, REST: ReservedInstancePool.Get
Returns the specified reserved instance pool resource.
To get the list of available reserved instance pool resources, make a List request.
HTTP request
GET https://compute.api.cloud.yandex.net/compute/v1/reservedInstancePools/{reservedInstancePoolId}
Path parameters
|
Field |
Description |
|
reservedInstancePoolId |
string Required field. ID of the reserved instance pool resource to return. |
Response
HTTP Code: 200 - OK
{
"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"
}
}
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 text format. The range of possible values is from 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). |
|
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). |
|
slotStats |
Statuses of the pool slots |
|
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. 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
|
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 |