- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- Try it!
Lists all instances in a project for either a specified location or for all locations.
HTTP request
GET https://file.googleapis.com/v1beta1/{parent=projects/*/locations/*}/instances
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
The project and location for which to retrieve instance information, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example us-west1-b. To retrieve instance information for all locations, use "-" for the {location} value. |
Query parameters
Parameters | |
---|---|
pageSize |
The maximum number of items to return. |
pageToken |
The nextPageToken value to use if there are additional results to retrieve for this list request. |
orderBy |
Sort results. Supported values are "name", "name desc" or "" (unsorted). |
filter |
List filter. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
ListInstancesResponse is the result of ListInstancesRequest.
JSON representation | |
---|---|
{
"instances": [
{
object ( |
Fields | |
---|---|
instances[] |
A list of instances in the project for the specified location. If the {location} value in the request is "-", the response contains a list of instances from all locations. If any location is unreachable, the response will only return instances in reachable locations and the "unreachable" field will be populated with a list of unreachable locations. |
nextPageToken |
The token you can use to retrieve the next page of results. Not returned if there are no more results in the list. |
unreachable[] |
Locations that could not be reached. |
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.