Yandex Cloud
  • Services
  • Solutions
  • Why Yandex Cloud
  • Pricing
  • Documentation
  • Contact us
Get started
Language / Region
© 2022 Yandex.Cloud LLC
Yandex Compute Cloud
  • Getting started
    • Overview
    • Creating a Linux VM
    • Creating a Windows VM
    • Creating instance groups
  • Step-by-step instructions
    • All instructions
    • Creating VMs
      • Creating a Linux VM
      • Creating a Windows VM
      • Creating a VM from a set of disks
      • Creating a VM with disks from snapshots
      • Creating a VM from a custom image
      • Creating a VM with a GPU
      • Making a VM preemptible
    • DSVM
      • Overview
      • Creating a VM from a public DSVM image
    • Placement groups
      • Creating a placement group
      • Deleting a placement group
      • Creating a VM in a placement group
      • Adding a VM to a placement group
      • Removing a VM from a placement group
    • Images with pre-installed software
      • Creating a VM from a public image
      • Configuring software
      • Running a VM based on a public image
      • Getting a list of public images
    • Getting information about a VM
      • Getting information about a VM
      • Getting serial port's output
    • Managing VMs
      • Stopping and starting a VM
      • Resetting a VM user password
      • Attaching a disk to a VM
      • Detaching a disk from a VM
      • Moving a VM to a different availability zone
      • Moving a VM to another folder
      • Attaching a public IP address to a VM
      • Detaching a public IP address from a VM
      • Making a VM's public IP address static
      • Updating a VM
      • Changing VM computing resources
      • Deleting a VM
    • Working on VMs
      • Connecting to a VM via SSH
      • Connecting to a VM via RDP
      • Connecting to a VM via PowerShell
      • Working with Yandex Cloud from inside a VM
      • Installing NVIDIA drivers
      • Restoring access to a VM
    • Managing the password reset agent
      • Verifying agent operation
      • Installing the agent
      • Deleting the agent
    • Creating new disks
      • Creating an empty disk
      • Creating an empty disk with a large block
      • Creating a non-replicated disk
    • Disk management
      • Creating a disk snapshot
      • Updating a disk
      • Moving a disk to another folder
      • Deleting a disk
      • Deleting a disk snapshot
    • Disk placement groups
      • Creating a disk placement group
      • Removing a disk from a placement group
    • Creating new images
      • Preparing a disk image
      • Uploading your image
      • Creating an image from a disk
      • Creating an image from a snapshot
      • Creating an image from other custom image
    • Managing images
      • Getting a list of images
      • Deleting a disk image
    • File storage
      • Creating file storage
      • Attaching file storage to a VM
      • Detaching file storage from a VM
      • Updating file storage
      • Deleting file storage
    • Managing the serial console
      • Getting started
      • Connecting to a serial console via SSH
      • Connecting to a serial console via CLI
      • Starting your terminal in the Windows serial console (SAC)
      • Disabling access to the serial console
    • Creating instance groups
      • Creating a fixed-size instance group
      • Creating a fixed-size instance group with a network load balancer
      • Creating a fixed-size instance group with an L7 load balancer
      • Creating an automatically scaled instance group
      • Creating an instance group from a Container Optimized Image
      • Creating an instance group based on the YAML specification
    • Getting information about instance groups
      • Getting a list of instance groups
      • Getting information about an instance group
      • Getting a list of instances in a group
    • Managing instance groups
      • Editing an instance group
      • Edit an instance group based on the YAML specification
      • Configuring application health check on the VM
      • Updating a group
        • Incremental update
        • Uninterrupted updates
      • Pausing an instance group
      • Resuming an instance group
      • Stopping an instance group
      • Starting an instance group
      • Deleting an instance group
    • Dedicated hosts
      • Creating a VM in a group of dedicated hosts
      • Creating a VM on a dedicated host
  • Yandex Container Solution
  • Practical guidelines
    • Configuring NTP time synchronization
    • Running instance groups with auto scaling
    • Automatically scaling an instance group for handling messages from a queue
    • Updating an instance group under load
    • Deploying Remote Desktop Gateway
    • Transferring logs from a VM instance to Yandex Cloud Logging
    • Creating a VM backup with Hystax Acura Backup
  • Concepts
    • Relationship between resources
    • Virtual machines
      • Overview
      • Platforms
      • vCPU performance levels
      • Preemptible VMs
      • Network on a VM
      • Software-accelerated network
      • Live migration
      • Placement groups
      • Statuses
      • Metadata
      • Resetting a Windows VM password
    • Graphics accelerators
    • Disks and file storage
      • Overview
      • Disks
      • Disk snapshots
      • Non-replicated disk placement groups
      • File storage
      • Read and write operations
    • Images
    • Instance groups
      • Overview
      • Access
      • YAML specification
      • Instance template
      • Variables in an instance template
      • Policies
        • Overview
        • Allocation policy
        • Deployment policy
        • Scaling policy
      • Scaling types
      • Auto-healing
      • Updating
        • Overview
        • Allocating instances across zones
        • Deployment algorithm
        • Rules for updating virtual machines
        • Changing secondary disks in an instance template
      • Stopping and pausing an instance group
      • Statuses
    • Dedicated host
    • Backups
    • Quotas and limits
  • Access management
  • Pricing policy
    • Current pricing policy
    • Archive
      • Before January 1, 2019
      • From January 1 to March 1, 2019
      • From March 1 to May 1, 2019
  • API reference
    • Authentication in the API
    • gRPC
      • Overview
      • DiskPlacementGroupService
      • DiskService
      • DiskTypeService
      • FilesystemService
      • HostGroupService
      • HostTypeService
      • ImageService
      • InstanceService
      • PlacementGroupService
      • SnapshotScheduleService
      • SnapshotService
      • ZoneService
      • InstanceGroupService
      • OperationService
    • REST
      • Overview
      • DiskPlacementGroup
        • Overview
        • create
        • delete
        • get
        • list
        • listDisks
        • listOperations
        • update
      • Disk
        • Overview
        • create
        • delete
        • get
        • list
        • listOperations
        • move
        • update
      • DiskType
        • Overview
        • get
        • list
      • Filesystem
        • Overview
        • create
        • delete
        • get
        • list
        • listOperations
        • update
      • HostGroup
        • Overview
        • create
        • delete
        • get
        • list
        • listHosts
        • listInstances
        • listOperations
        • update
      • HostType
        • Overview
        • get
        • list
      • Image
        • Overview
        • create
        • delete
        • get
        • getLatestByFamily
        • list
        • listOperations
        • update
      • Instance
        • Overview
        • addOneToOneNat
        • attachDisk
        • attachFilesystem
        • create
        • delete
        • detachDisk
        • detachFilesystem
        • get
        • getSerialPortOutput
        • list
        • listOperations
        • move
        • removeOneToOneNat
        • restart
        • start
        • stop
        • update
        • updateMetadata
        • updateNetworkInterface
      • PlacementGroup
        • Overview
        • create
        • delete
        • get
        • list
        • listInstances
        • listOperations
        • update
      • SnapshotSchedule
        • Overview
        • create
        • delete
        • disable
        • enable
        • get
        • list
        • listDisks
        • listOperations
        • listSnapshots
        • update
        • updateDisks
      • Snapshot
        • Overview
        • create
        • delete
        • get
        • list
        • listOperations
        • update
      • Zone
        • Overview
        • get
        • list
      • Operation
        • Overview
        • get
      • InstanceGroup
        • Overview
        • list
        • get
        • listLogRecords
        • updateFromYaml
        • updateAccessBindings
        • pauseProcesses
        • stop
        • start
        • delete
        • listInstances
        • createFromYaml
        • update
        • setAccessBindings
        • listOperations
        • create
        • listAccessBindings
        • resumeProcesses
  • Questions and answers
    • General questions
    • Virtual machines
    • Connection
    • Disks, snapshots, and images
    • Disaster recovery
    • Monitoring
    • Licensing
    • All questions on the same page
  1. API reference
  2. REST
  3. InstanceGroup
  4. listInstances

Method listInstances

Written by
Yandex Cloud
  • HTTP request
  • Path parameters
  • Query parameters
  • Response

Lists instances for the specified instance group.

HTTP request

GET https://compute.api.cloud.yandex.net/compute/v1/instanceGroups/{instanceGroupId}/instances

Path parameters

Parameter Description
instanceGroupId

Required. ID of the InstanceGroup resource to list instances for. To get the instance group ID, use a 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 name field.

The maximum string length in characters is 1000.

Response

HTTP Code: 200 - OK

{
  "instances": [
    {
      "id": "string",
      "status": "string",
      "instanceId": "string",
      "fqdn": "string",
      "name": "string",
      "statusMessage": "string",
      "zoneId": "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
              }
            ]
          }
        }
      ],
      "statusChangedAt": "string"
    }
  ],
  "nextPageToken": "string"
}
Field Description
instances[] object

Lists instances for the specified instance group.

instances[].
id
string

ID of the managed instance.

instances[].
status
string

Status of the managed instance.

  • CREATING_INSTANCE: Instance is being created.
  • UPDATING_INSTANCE: Instance is being updated.
  • DELETING_INSTANCE: Instance is being deleted.
  • STARTING_INSTANCE: Instance is being started.
  • STOPPING_INSTANCE: Instance is being stopped.
  • AWAITING_STARTUP_DURATION: Instance has been created successfully, but startup duration has not elapsed yet.
  • CHECKING_HEALTH: Instance has been created successfully and startup duration has elapsed, but health checks have not passed yet and the managed instance is not ready to receive traffic.
  • OPENING_TRAFFIC: Instance Groups is initiating health checks and routing traffic to the instances.
  • AWAITING_WARMUP_DURATION: Instance is now receiving traffic, but warmup duration has not elapsed yet.
  • CLOSING_TRAFFIC: Instance Groups has initiated the process of stopping routing traffic to the instances.
  • RUNNING_ACTUAL: Instance is running normally and its attributes match the current InstanceTemplate.
  • RUNNING_OUTDATED: Instance is running normally, but its attributes do not match the current InstanceTemplate. It will be updated, recreated or deleted shortly.
  • STOPPED: Instance was stopped.
  • DELETED: Instance was deleted.
  • PREPARING_RESOURCES: Instance Groups is preparing dependent resources.
instances[].
instanceId
string

ID of the instance.

instances[].
fqdn
string

Fully Qualified Domain Name.

instances[].
name
string

The name of the managed instance.

instances[].
statusMessage
string

Status message for the managed instance.

instances[].
zoneId
string

ID of the availability zone where the instance resides.

instances[].
networkInterfaces[]
object

Array of network interfaces that are attached to the managed 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 managed instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

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 IPv4 external network address that is assigned to the managed instance for this network interface.

instances[].
networkInterfaces[].
primaryV4Address.
oneToOneNat.
ipVersion
string

External IP address version.

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

External DNS configuration.

instances[].
networkInterfaces[].
primaryV4Address.
oneToOneNat.
dnsRecords[].
fqdn
string

Required. 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 (optional, if not set, some private zone is used).

instances[].
networkInterfaces[].
primaryV4Address.
oneToOneNat.
dnsRecords[].
ttl
string (int64)

DNS record ttl (optional, if 0, a reasonable default is used).

Acceptable values are 0 to 86400, inclusive.

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

Required. 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 (optional, if not set, some private zone is used).

instances[].
networkInterfaces[].
primaryV4Address.
dnsRecords[].
ttl
string (int64)

DNS record ttl (optional, if 0, a reasonable default is used).

Acceptable values are 0 to 86400, inclusive.

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 is not available yet.

instances[].
networkInterfaces[].
primaryV6Address.
address
string

An IPv4 internal network address that is assigned to the managed instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

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 IPv4 external network address that is assigned to the managed instance for this network interface.

instances[].
networkInterfaces[].
primaryV6Address.
oneToOneNat.
ipVersion
string

External IP address version.

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

External DNS configuration.

instances[].
networkInterfaces[].
primaryV6Address.
oneToOneNat.
dnsRecords[].
fqdn
string

Required. 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 (optional, if not set, some private zone is used).

instances[].
networkInterfaces[].
primaryV6Address.
oneToOneNat.
dnsRecords[].
ttl
string (int64)

DNS record ttl (optional, if 0, a reasonable default is used).

Acceptable values are 0 to 86400, inclusive.

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

Required. 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 (optional, if not set, some private zone is used).

instances[].
networkInterfaces[].
primaryV6Address.
dnsRecords[].
ttl
string (int64)

DNS record ttl (optional, if 0, a reasonable default is used).

Acceptable values are 0 to 86400, inclusive.

instances[].
networkInterfaces[].
primaryV6Address.
dnsRecords[].
ptr
boolean (boolean)

When true, indicates there is a corresponding auto-created PTR DNS record.

instances[].
statusChangedAt
string (date-time)

The timestamp in RFC3339 text format when the status of the managed instance was last changed.

String in RFC3339 text format.

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.

Was the article helpful?

Language / Region
© 2022 Yandex.Cloud LLC
In this article:
  • HTTP request
  • Path parameters
  • Query parameters
  • Response