Get started
Language / Region
© 2022 Yandex.Cloud LLC
Yandex Compute Cloud

Method listInstances

Written by

Lists instances that belongs to the specified host group.

HTTP request

GET https://compute.api.cloud.yandex.net/compute/v1/hostGroups/{hostGroupId}/instances

Path parameters

Parameter Description
hostGroupId

Required. ID of the host group to list instances for. To get the host group ID, use list request.

The maximum string length in characters is 50.

Query parameters

Parameter Description
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. Currently you can use filtering only on the id field. To get the host ID, use listHosts request.

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",
      "metadataOptions": {
        "gceHttpEndpoint": "string",
        "awsV1HttpEndpoint": "string",
        "gceHttpToken": "string",
        "awsV1HttpToken": "string"
      },
      "bootDisk": {
        "mode": "string",
        "deviceName": "string",
        "autoDelete": true,
        "diskId": "string"
      },
      "secondaryDisks": [
        {
          "mode": "string",
          "deviceName": "string",
          "autoDelete": true,
          "diskId": "string"
        }
      ],
      "localDisks": [
        {
          "size": "string",
          "deviceName": "string"
        }
      ],
      "filesystems": [
        {
          "mode": "string",
          "deviceName": "string",
          "filesystemId": "string"
        }
      ],
      "networkInterfaces": [
        {
          "index": "string",
          "macAddress": "string",
          "subnetId": "string",
          "primaryV4Address": {
            "address": "string",
            "oneToOneNat": {
              "address": "string",
              "ipVersion": "string",
              "dnsRecords": [
                {
                  "fqdn": "string",
                  "dnsZoneId": "string",
                  "ttl": "string",
                  "ptr": true
                }
              ]
            },
            "dnsRecords": [
              {
                "fqdn": "string",
                "dnsZoneId": "string",
                "ttl": "string",
                "ptr": true
              }
            ]
          },
          "primaryV6Address": {
            "address": "string",
            "oneToOneNat": {
              "address": "string",
              "ipVersion": "string",
              "dnsRecords": [
                {
                  "fqdn": "string",
                  "dnsZoneId": "string",
                  "ttl": "string",
                  "ptr": true
                }
              ]
            },
            "dnsRecords": [
              {
                "fqdn": "string",
                "dnsZoneId": "string",
                "ttl": "string",
                "ptr": true
              }
            ]
          },
          "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

Lists instances for the specified host group.
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 key:value pairs. Maximum of 64 per resource.
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.

  • PROVISIONING: Instance is waiting for resources to be allocated.
  • RUNNING: Instance is running normally.
  • STOPPING: Instance is being stopped.
  • STOPPED: Instance stopped.
  • STARTING: Instance is being started.
  • RESTARTING: Instance is being restarted.
  • UPDATING: Instance is being updated.
  • ERROR: Instance encountered a problem and cannot operate.
  • CRASHED: Instance crashed and will be restarted automatically.
  • DELETING: Instance is being deleted.
instances[].
metadata		 object

The metadata key:value pairs assigned to this instance. This includes custom metadata and predefined keys.

For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata.
instances[].
metadataOptions		 object

Options allow user to configure access to instance's metadata
instances[].
metadataOptions.
gceHttpEndpoint		 string

Enabled access to GCE flavored metadata

  • ENABLED: Option is enabled
  • DISABLED: Option is disabled
instances[].
metadataOptions.
awsV1HttpEndpoint		 string

Enabled access to AWS flavored metadata (IMDSv1)

  • ENABLED: Option is enabled
  • DISABLED: Option is disabled
instances[].
metadataOptions.
gceHttpToken		 string

Enabled access to IAM credentials with GCE flavored metadata

  • ENABLED: Option is enabled
  • DISABLED: Option is disabled
instances[].
metadataOptions.
awsV1HttpToken		 string

Enabled access to IAM credentials with AWS flavored metadata (IMDSv1)

  • ENABLED: Option is enabled
  • DISABLED: Option is disabled
instances[].
bootDisk		 object

Boot disk that is attached to the instance.
instances[].
bootDisk.
mode		 string

Access mode to the Disk resource.

  • READ_ONLY: Read-only access.
  • READ_WRITE: Read/Write access.
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.

  • READ_ONLY: Read-only access.
  • READ_WRITE: Read/Write access.
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[].
localDisks[]		 object

Array of local disks that are attached to the instance.
instances[].
localDisks[].
size		 string (int64)

Size of the disk, specified in bytes.
instances[].
localDisks[].
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[].
filesystems[]		 object

Array of filesystems that are attached to the instance.
instances[].
filesystems[].
mode		 string

Access mode to the filesystem.

  • READ_ONLY: Read-only access.
  • READ_WRITE: Read/Write access.
instances[].
filesystems[].
deviceName		 string

Name of the device representing the filesystem on the instance.

The name should be used for referencing the filesystem from within the instance when it's being mounted, resized etc.
instances[].
filesystems[].
filesystemId		 string

ID of the filesystem 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.

  • IPV4: IPv4 address, for example 192.0.2.235.
  • IPV6: IPv6 address. Not available yet.
instances[].
networkInterfaces[].
primaryV4Address.
oneToOneNat.
dnsRecords[]		 object

External DNS configuration
instances[].
networkInterfaces[].
primaryV4Address.
oneToOneNat.
dnsRecords[].
fqdn		 string

Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id).
instances[].
networkInterfaces[].
primaryV4Address.
oneToOneNat.
dnsRecords[].
dnsZoneId		 string

DNS zone id for the record (optional, if not set, some private zone is used).
instances[].
networkInterfaces[].
primaryV4Address.
oneToOneNat.
dnsRecords[].
ttl		 string (int64)

DNS record ttl (optional, if not set, a reasonable default is used.)
instances[].
networkInterfaces[].
primaryV4Address.
oneToOneNat.
dnsRecords[].
ptr		 boolean (boolean)

When true, indicates there is a corresponding auto-created PTR DNS record.
instances[].
networkInterfaces[].
primaryV4Address.
dnsRecords[]		 object

Internal DNS configuration
instances[].
networkInterfaces[].
primaryV4Address.
dnsRecords[].
fqdn		 string

Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id).
instances[].
networkInterfaces[].
primaryV4Address.
dnsRecords[].
dnsZoneId		 string

DNS zone id for the record (optional, if not set, some private zone is used).
instances[].
networkInterfaces[].
primaryV4Address.
dnsRecords[].
ttl		 string (int64)

DNS record ttl (optional, if not set, a reasonable default is used.)
instances[].
networkInterfaces[].
primaryV4Address.
dnsRecords[].
ptr		 boolean (boolean)

When true, indicates there is a corresponding auto-created PTR DNS record.
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.

  • IPV4: IPv4 address, for example 192.0.2.235.
  • IPV6: IPv6 address. Not available yet.
instances[].
networkInterfaces[].
primaryV6Address.
oneToOneNat.
dnsRecords[]		 object

External DNS configuration
instances[].
networkInterfaces[].
primaryV6Address.
oneToOneNat.
dnsRecords[].
fqdn		 string

Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id).
instances[].
networkInterfaces[].
primaryV6Address.
oneToOneNat.
dnsRecords[].
dnsZoneId		 string

DNS zone id for the record (optional, if not set, some private zone is used).
instances[].
networkInterfaces[].
primaryV6Address.
oneToOneNat.
dnsRecords[].
ttl		 string (int64)

DNS record ttl (optional, if not set, a reasonable default is used.)
instances[].
networkInterfaces[].
primaryV6Address.
oneToOneNat.
dnsRecords[].
ptr		 boolean (boolean)

When true, indicates there is a corresponding auto-created PTR DNS record.
instances[].
networkInterfaces[].
primaryV6Address.
dnsRecords[]		 object

Internal DNS configuration
instances[].
networkInterfaces[].
primaryV6Address.
dnsRecords[].
fqdn		 string

Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id).
instances[].
networkInterfaces[].
primaryV6Address.
dnsRecords[].
dnsZoneId		 string

DNS zone id for the record (optional, if not set, some private zone is used).
instances[].
networkInterfaces[].
primaryV6Address.
dnsRecords[].
ttl		 string (int64)

DNS record ttl (optional, if not set, a reasonable default is used.)
instances[].
networkInterfaces[].
primaryV6Address.
dnsRecords[].
ptr		 boolean (boolean)

When true, indicates there is a corresponding auto-created PTR DNS record.
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 <hostname>.<region_id>.internal when the instance is created. If the hostname were not specified when the instance was created, FQDN would be <id>.auto.internal.
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

  • STANDARD: Standard network.
  • SOFTWARE_ACCELERATED: Software accelerated network.
  • HARDWARE_ACCELERATED: Hardware accelerated network (not available yet, reserved for future use).
instances[].
placementPolicy		 object

Placement policy configuration.
instances[].
placementPolicy.
placementGroupId		 string

Placement group ID.
instances[].
placementPolicy.
hostAffinityRules[]		 object

List of affinity rules. Scheduler will attempt to allocate instances according to order of rules.
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 more than pageSize, use 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.
Language / Region
© 2022 Yandex.Cloud LLC
In this article: