---
title: "POST /projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances"
method: POST
path: "/projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances"
tags: ["regionInstanceGroups"]
---

# POST /projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances

`POST /projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances`

Lists the instances in the specified instance group and displays
information about the named ports. Depending on the specified options, this
method can list all instances or only the instances that are running.
The orderBy query parameter is not supported.

## Path parameters

- `project` string, required
- `region` string, required
- `instanceGroup` string, required

## Query parameters

- `filter` string
- `maxResults` integer
- `orderBy` string
- `pageToken` string
- `returnPartialSuccess` boolean

## Request body

- RegionInstanceGroupsListInstancesRequest
  - `instanceState` 'ALL' | 'RUNNING' — Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default, it lists all instances.
  - `portName` string — Name of port user is interested in. It is optional. If it is set, only information about this ports will be returned. If it is not set, all the named ports will be returned. Always lists all instances.

## Response `200`

Successful response

---

[API](https://skmtc.net/google/apis/compute.md) · [All operations](https://skmtc.net/google/apis/compute/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/compute/versions/6120ed8969d4/schema)
