Required. The project and location for which to retrieve instance information, in the format projects/{projectId}/locations/{location}. In Cloud Filestore, locations map to Google Cloud zones, for example us-west1-b. To retrieve instance information for all locations, use "-" for the {location} value.
Query parameters
Parameters
pageSize
integer
The maximum number of items to return.
pageToken
string
The nextPageToken value to use if there are additional results to retrieve for this list request.
orderBy
string
Sort results. Supported values are "name", "name desc" or "" (unsorted).
filter
string
List filter.
Request body
The request body must be empty.
Response body
ListInstancesResponse is the result of ListInstancesRequest.
If successful, the response body contains data with the following structure:
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
string
The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.
unreachable[]
string
Unordered list. Locations that could not be reached.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-17 UTC."],[[["\u003cp\u003eThis document describes how to list all instances in a project, either for a specific location or across all locations using a \u003ccode\u003eGET\u003c/code\u003e HTTP request.\u003c/p\u003e\n"],["\u003cp\u003eThe request URL requires a \u003ccode\u003eparent\u003c/code\u003e path parameter in the format \u003ccode\u003eprojects/{projectId}/locations/{location}\u003c/code\u003e, with the option to use "-" for \u003ccode\u003e{location}\u003c/code\u003e to retrieve information for all locations.\u003c/p\u003e\n"],["\u003cp\u003eThe request accepts optional query parameters like \u003ccode\u003epageSize\u003c/code\u003e, \u003ccode\u003epageToken\u003c/code\u003e, \u003ccode\u003eorderBy\u003c/code\u003e, and \u003ccode\u003efilter\u003c/code\u003e to manage and sort the list of instances.\u003c/p\u003e\n"],["\u003cp\u003eThe response body includes a list of \u003ccode\u003einstances\u003c/code\u003e, a \u003ccode\u003enextPageToken\u003c/code\u003e for pagination, and an \u003ccode\u003eunreachable\u003c/code\u003e list of locations that could not be reached.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must be left empty, and to successfully make the call, you will need the authorization scope: \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,[]]
