Method listInstances

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 an 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 InstanceGroup.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"
            }
          },
          "primaryV6Address": {
            "address": "string",
            "oneToOneNat": {
              "address": "string",
              "ipVersion": "string"
            }
          }
        }
      ],
      "statusChangedAt": "string"
    }
  ],
  "nextPageToken": "string"
}
Field Description
instances[] object

A ManagedInstance resource. For more information, see Instance Groups Concepts.

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.
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[].
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[].
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.