Requires authorization
Lists instances under a given project in alphabetical order by instance name.
Request
HTTP request
GET https://www.googleapis.com/sql/v1beta4/projects/project/instances
Parameters
Parameter name | Value | Description |
---|---|---|
Path parameters | ||
project |
string |
Project ID of the project for which to list Cloud SQL instances. |
Optional query parameters | ||
filter |
string |
An expression for filtering the results of the request, such as by name or label. |
maxResults |
unsigned integer |
The maximum number of results to return per response. |
pageToken |
string |
A previously-returned page token representing part of the larger set of results to view. |
Authorization
This request requires authorization with at least one of the following scopes (read more about authentication and authorization).
Scope |
---|
https://www.googleapis.com/auth/sqlservice.admin |
https://www.googleapis.com/auth/cloud-platform |
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response body with the following structure:
{ "kind": "sql#instancesList", "nextPageToken": string, "items": [ instances Resource ], "warnings": [ { "code": string, "message": string } ] }
Property name | Value | Description | Notes |
---|---|---|---|
kind |
string |
This is always sql#instancesList . |
|
items[] |
list |
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. | |
warnings[] |
list |
List of warnings that ocurred while handling the request. | |
warnings[].code |
string |
Code to uniquely identify the warning type. | |
warnings[].message |
string |
The warning message. |