Send feedback
Method: projects.instances.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists all instances in the given project.
HTTP request
GET https://spanner.googleapis.com/v1/{parent=projects/*}/instances
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters
parent
string
Required. The name of the project for which a list of instances is requested. Values are of the form projects/<project>
.
Authorization requires the following IAM permission on the specified resource parent
:
Query parameters
Parameters
pageSize
integer
Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
pageToken
string
If non-empty, pageToken
should contain a nextPageToken
from a previous ListInstancesResponse
.
filter
string
An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:
name
displayName
labels.key
where key is the name of a label
Some examples of using filters are:
name:*
--> The instance has a name.
name:Howl
--> The instance's name contains the string "howl".
name:HOWL
--> Equivalent to above.
NAME:howl
--> Equivalent to above.
labels.env:*
--> The instance has the label "env".
labels.env:dev
--> The instance has the label "env" and the value of the label contains the string "dev".
name:howl labels.env:dev
--> The instance's name contains "howl" and it has the label "env" with its value containing "dev".
instanceDeadline
string (Timestamp
format)
Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to unreachable
in ListInstancesResponse
.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z"
and "2014-10-02T15:01:23.045123456Z"
.
Request body
The request body must be empty.
Response body
The response for instances.list
.
If successful, the response body contains data with the following structure:
JSON representation
{
"instances" : [
{
object (Instance
)
}
] ,
"nextPageToken" : string ,
"unreachable" : [
string
]
}
Fields
instances[]
object (Instance
)
The list of requested instances.
nextPageToken
string
nextPageToken
can be sent in a subsequent instances.list
call to fetch more of the matching instances.
unreachable[]
string
The list of unreachable instances. It includes the names of instances whose metadata could not be retrieved within instanceDeadline
.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/spanner.admin
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-07-09 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
Need to tell us more?