- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Lists all instance partitions for the given instance.
HTTP request
GET https://spanner.googleapis.com/v1/{parent=projects/*/instances/*}/instancePartitions
The URLs use gRPC Transcoding syntax.
Path parameters
parent
string
Required. The instance whose instance partitions should be listed. Values are of the form projects/<project>/instances/<instance>
. Use {instance} = '-'
to list instance partitions for all Instances in a project, e.g., projects/myproject/instances/-
.
Authorization requires the following IAM
permission on the specified resource parent
:
-
spanner.instancePartitions.list
Query parameters
| Parameters | |
|---|---|
pageSize
|
Number of instance partitions to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. |
pageToken
|
If non-empty, |
instancePartitionDeadline
|
Optional. Deadline used while retrieving metadata for instance partitions. Instance partitions whose metadata cannot be retrieved within this deadline will be added to Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
Request body
The request body must be empty.
Response body
The response for instancePartitions.list
.
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{
"instancePartitions"
:
[
{
object (
|
| Fields | |
|---|---|
instancePartitions[]
|
The list of requested instancePartitions. |
nextPageToken
|
|
unreachable[]
|
The list of unreachable instances or instance partitions. It includes the names of instances or instance partitions whose metadata could not be retrieved within |
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 .
