Method list
Retrieves the list of Instance resources in the specified folder.
HTTP request
GET https://compute.api.cloud.yandex.net/compute/v1/instances
Query parameters
Parameter | Description |
---|---|
folderId | Required. ID of the Folder to list instances in. To get the folder ID, use a list request. The maximum string length in characters is 50. |
pageSize | The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
pageToken | Page token. To get the next page of results, set pageToken to the nextPageToken returned by a previous list request. The maximum string length in characters is 100. |
filter | A filter expression that filters resources listed in the response. The expression must specify: 1. The field name. Currently you can use filtering only on the Instance.name field. 2. An operator. Can be either = or != for single values, IN or NOT IN for lists of values. 3. The value. Must be 3-63 characters long and match the regular expression ^[a-z]([-a-z0-9]{,61}[a-z0-9])?$ . The maximum string length in characters is 1000. |
Response
HTTP Code: 200 - OK
{
"instances": [
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"zoneId": "string",
"platformId": "string",
"resources": {
"memory": "string",
"cores": "string",
"coreFraction": "string",
"gpus": "string"
},
"status": "string",
"metadata": "object",
"bootDisk": {
"mode": "string",
"deviceName": "string",
"autoDelete": true,
"diskId": "string"
},
"secondaryDisks": [
{
"mode": "string",
"deviceName": "string",
"autoDelete": true,
"diskId": "string"
}
],
"networkInterfaces": [
{
"index": "string",
"macAddress": "string",
"subnetId": "string",
"primaryV4Address": {
"address": "string",
"oneToOneNat": {
"address": "string",
"ipVersion": "string"
}
},
"primaryV6Address": {
"address": "string",
"oneToOneNat": {
"address": "string",
"ipVersion": "string"
}
},
"securityGroupIds": [
"string"
]
}
],
"fqdn": "string",
"schedulingPolicy": {
"preemptible": true
},
"serviceAccountId": "string",
"networkSettings": {
"type": "string"
},
"placementPolicy": {
"placementGroupId": "string",
"hostAffinityRules": [
{
"key": "string",
"op": "string",
"values": [
"string"
]
}
]
}
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
instances[] | object An Instance resource. For more information, see Instances. |
instances[]. id |
string ID of the instance. |
instances[]. folderId |
string ID of the folder that the instance belongs to. |
instances[]. createdAt |
string (date-time) String in RFC3339 text format. |
instances[]. name |
string Name of the instance. 1-63 characters long. |
instances[]. description |
string Description of the instance. 0-256 characters long. |
instances[]. labels |
object Resource labels as |
instances[]. zoneId |
string ID of the availability zone where the instance resides. |
instances[]. platformId |
string ID of the hardware platform configuration for the instance. |
instances[]. resources |
object Computing resources of the instance such as the amount of memory and number of cores. |
instances[]. resources. memory |
string (int64) The amount of memory available to the instance, specified in bytes. |
instances[]. resources. cores |
string (int64) The number of cores available to the instance. |
instances[]. resources. 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. |
instances[]. resources. gpus |
string (int64) The number of GPUs available to the instance. |
instances[]. status |
string Status of the instance.
|
instances[]. metadata |
object The metadata For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata. |
instances[]. bootDisk |
object Boot disk that is attached to the instance. |
instances[]. bootDisk. mode |
string Access mode to the Disk resource.
|
instances[]. bootDisk. deviceName |
string Serial number that is reflected into the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance. |
instances[]. bootDisk. autoDelete |
boolean (boolean) Specifies whether the disk will be auto-deleted when the instance is deleted. |
instances[]. bootDisk. diskId |
string ID of the disk that is attached to the instance. |
instances[]. secondaryDisks[] |
object Array of secondary disks that are attached to the instance. |
instances[]. secondaryDisks[]. mode |
string Access mode to the Disk resource.
|
instances[]. secondaryDisks[]. deviceName |
string Serial number that is reflected into the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance. |
instances[]. secondaryDisks[]. autoDelete |
boolean (boolean) Specifies whether the disk will be auto-deleted when the instance is deleted. |
instances[]. secondaryDisks[]. diskId |
string ID of the disk that is attached to the instance. |
instances[]. networkInterfaces[] |
object Array of network interfaces that are attached to the instance. |
instances[]. networkInterfaces[]. index |
string The index of the network interface, generated by the server, 0,1,2... etc. Currently only one network interface is supported per instance. |
instances[]. networkInterfaces[]. macAddress |
string MAC address that is assigned to the network interface. |
instances[]. networkInterfaces[]. subnetId |
string ID of the subnet. |
instances[]. networkInterfaces[]. primaryV4Address |
object Primary IPv4 address that is assigned to the instance for this network interface. |
instances[]. networkInterfaces[]. primaryV4Address. address |
string An IPv4 internal network address that is assigned to the instance for this network interface. |
instances[]. networkInterfaces[]. primaryV4Address. oneToOneNat |
object One-to-one NAT configuration. If missing, NAT has not been set up. |
instances[]. networkInterfaces[]. primaryV4Address. oneToOneNat. address |
string An external IP address associated with this instance. |
instances[]. networkInterfaces[]. primaryV4Address. oneToOneNat. ipVersion |
string IP version for the external IP address.
|
instances[]. networkInterfaces[]. primaryV6Address |
object Primary IPv6 address that is assigned to the instance for this network interface. IPv6 not available yet. |
instances[]. networkInterfaces[]. primaryV6Address. address |
string An IPv4 internal network address that is assigned to the instance for this network interface. |
instances[]. networkInterfaces[]. primaryV6Address. oneToOneNat |
object One-to-one NAT configuration. If missing, NAT has not been set up. |
instances[]. networkInterfaces[]. primaryV6Address. oneToOneNat. address |
string An external IP address associated with this instance. |
instances[]. networkInterfaces[]. primaryV6Address. oneToOneNat. ipVersion |
string IP version for the external IP address.
|
instances[]. networkInterfaces[]. securityGroupIds[] |
string ID's of security groups attached to the interface |
instances[]. fqdn |
string A domain name of the instance. FQDN is defined by the server in the format |
instances[]. schedulingPolicy |
object Scheduling policy configuration. |
instances[]. schedulingPolicy. preemptible |
boolean (boolean) True for short-lived compute instances. For more information, see Preemptible VMs. |
instances[]. serviceAccountId |
string ID of the service account to use for authentication inside the instance. To get the service account ID, use a list request. |
instances[]. networkSettings |
object Network Settings |
instances[]. networkSettings. type |
string Network Type
|
instances[]. placementPolicy |
object Placement policy configuration. |
instances[]. placementPolicy. placementGroupId |
string Placement group ID. |
instances[]. placementPolicy. hostAffinityRules[] |
object Affinitity definition |
instances[]. placementPolicy. hostAffinityRules[]. key |
string Affinity label or one of reserved values - 'yc.hostId', 'yc.hostGroupId' |
instances[]. placementPolicy. hostAffinityRules[]. op |
string Include or exclude action |
instances[]. placementPolicy. hostAffinityRules[]. values[] |
string Affinity value or host ID or host group ID |
nextPageToken | string This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken query parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results. |