- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Examples
- Try it!
Lists all Redis instances owned by a project in either the specified location (region) or all locations.
The location should have the following format:
projects/{projectId}/locations/{locationId}
If locationId
is specified as -
(wildcard), then all regions available to the project are queried, and the results are aggregated.
HTTP request
GET https://redis.googleapis.com/v1beta1/{parent=projects/*/locations/*}/instances
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. The resource name of the instance location using the form: |
Query parameters
Parameters | |
---|---|
pageSize |
The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the pageSize value, the response may include a partial list and a caller should only rely on response's |
pageToken |
The |
Request body
The request body must be empty.
Response body
Response for instances.list
.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"instances": [
{
object ( |
Fields | |
---|---|
instances[] |
A list of Redis instances in the project in the specified location, or across all locations. If the |
nextPageToken |
Token to retrieve the next page of results, or empty 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.