Stay organized with collections Save and categorize content based on your preferences.
Lists instances under a given project.
HTTP requestGET https://sqladmin.googleapis.com/v1/projects/{project}/instances
The URL uses gRPC Transcoding syntax.
Path parameters Parametersproject
string
Project ID of the project for which to list Cloud SQL instances.
Query parameters Parametersfilter
string
A filter expression that filters resources listed in the response. The expression is in the form of field:value. For example, 'instanceType:CLOUD_SQL_INSTANCE'. Fields can be nested as needed as per their JSON representation, such as 'settings.userLabels.auto_start:true'.
Multiple filter queries are space-separated. For example. 'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly.
maxResults
integer (uint32 format)
The maximum number of instances to return. The service may return fewer than this value. If unspecified, at most 500 instances are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
pageToken
string
A previously-returned page token representing part of the larger set of results to view.
Request bodyThe request body must be empty.
Response bodyIf successful, the response body contains data with the following structure:
Database instances list response.
JSON representation{
"kind": string,
"warnings": [
{
object (ApiWarning)
}
],
"items": [
{
object (DatabaseInstance)
}
],
"nextPageToken": string
} Fields kind
string
This is always sql#instancesList.
warnings[]
object (ApiWarning)
instances.list of warnings that occurred while handling the request.
items[]
object (DatabaseInstance)
instances.list of database instance resources.
nextPageToken
string
The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.adminFor more information, see the Authentication Overview.
ApiWarningAn Admin API warning message.
JSON representation{
"code": enum (SqlApiWarningCode),
"message": string,
"region": string
} Fields code
enum (SqlApiWarningCode)
Code to uniquely identify the warning type.
message
string
The warning message.
region
string
The region name for REGION_UNREACHABLE warning.
SqlApiWarningCode EnumsSQL_API_WARNING_CODE_UNSPECIFIED An unknown or unset warning type from Cloud SQL API. REGION_UNREACHABLE Warning when one or more regions are not reachable. The returned result set may be incomplete. MAX_RESULTS_EXCEEDS_LIMIT Warning when user provided maxResults parameter exceeds the limit. The returned result set may be incomplete.
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-05-30 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-30 UTC."],[],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4