Compute Cloud API, REST: ReservedInstancePool.List
Retrieves the list of reserved instance pool resources in the specified folder.
HTTP request
GET https://compute.api.cloud.yandex.net/compute/v1/reservedInstancePools
Query parameters
Field |
Description |
folderId |
string Required field. ID of the Folder to list reserved instance pools in. |
pageSize |
string (int64) The maximum number of results per page to return. If the number of available |
pageToken |
string Page token. To get the next page of results, |
filter |
string A filter expression that filters resources listed in the response. Each condition has the form
|
orderBy |
string By which column the listing should be ordered and in which direction, |
Response
HTTP Code: 200 - OK
{
"reservedInstancePools": [
{
"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"
}
],
"nextPageToken": "string"
}
Field |
Description |
reservedInstancePools[] |
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 |
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 |
createdAt |
string (date-time) String in RFC3339 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). |
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
|