Lists instances under a given project.
Arguments
Parameters | |
---|---|
project |
Required. Project ID of the project for which to list Cloud SQL instances.
|
filter |
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 |
The maximum number of results to return per response.
|
pageToken |
A previously-returned page token representing part of the larger set of results to view.
|
Raised exceptions
Exceptions | |
---|---|
ConnectionError |
In case of a network problem (such as DNS failure or refused connection). |
HttpError |
If the response status is >= 400 (excluding 429 and 503). |
TimeoutError |
If a long-running operation takes longer to finish than the specified timeout limit. |
TypeError |
If an operation or function receives an argument of the wrong type. |
ValueError |
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout. |
Response
If successful, the response contains an instance of InstancesListResponse
.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation.
YAML
- list: call: googleapis.sqladmin.v1.instances.list args: project: ... filter: ... maxResults: ... pageToken: ... result: listResult
JSON
[ { "list": { "call": "googleapis.sqladmin.v1.instances.list", "args": { "project": "...", "filter": "...", "maxResults": "...", "pageToken": "..." }, "result": "listResult" } } ]