- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Gets information about a particular instance.
HTTP request
The URLs use gRPC Transcoding syntax.
Path parameters
name
string
Required. The name of the requested instance. Values are of the form projects/<project>/instances/<instance>
.
Authorization requires the following IAM
permission on the specified resource name
:
-
spanner.instances.get
Query parameters
| Parameters | |
|---|---|
fieldMask
|
If fieldMask is present, specifies the subset of This is a comma-separated list of fully qualified names of fields. Example: |
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Instance
.
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 .

