Method: projects.instanceConfigs.list

Lists the supported instance configurations for a given project.

Returns both Google-managed configurations and user-managed configurations.

HTTP request


The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The name of the project for which a list of supported instance configurations is requested. Values are of the form projects/<project>.

Authorization requires the following IAM permission on the specified resource parent:

  • spanner.instanceConfigs.list

Query parameters

Parameters
pageSize

integer

Number of instance configurations 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 ListInstanceConfigsResponse .

Request body

The request body must be empty.

Response body

The response for instanceConfigs.list .

If successful, the response body contains data with the following structure:

JSON representation 
{
 "instanceConfigs": [
 {
 object (InstanceConfig )
 }
 ],
 "nextPageToken": string
}
Fields
instanceConfigs[]

object (InstanceConfig )

The list of requested instance configurations.
nextPageToken

string

nextPageToken can be sent in a subsequent instanceConfigs.list call to fetch more of the matching instance configurations.

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.

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 2025年06月18日 UTC.