Method: googleapis.spanner.v1.projects.instances.list

Lists all instances in the given project.

Arguments

Parameters
parent	string Required. The name of the project for which a list of instances is requested. Values are of the form projects/.
filter	string An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * name * display_name * labels.key where key is the name of a label Some examples of using filters are: * name:* --> The instance has a name. * name:Howl --> The instance's name contains the string "howl". * name:HOWL --> Equivalent to above. * NAME:howl --> Equivalent to above. * labels.env:* --> The instance has the label "env". * labels.env:dev --> The instance has the label "env" and the value of the label contains the string "dev". * name:howl labels.env:dev --> The instance's name contains "howl" and it has the label "env" with its value containing "dev".
instanceDeadline	string (Timestamp format) Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancesResponse.
pageSize	integer (int32 format) Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
pageToken	string If non-empty, page_token should contain a next_page_token from a previous ListInstancesResponse.

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 ListInstancesResponse.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- list:
    call: googleapis.spanner.v1.projects.instances.list
    args:
        parent: ...
        filter: ...
        instanceDeadline: ...
        pageSize: ...
        pageToken: ...
    result: listResult

JSON

[
  {
    "list": {
      "call": "googleapis.spanner.v1.projects.instances.list",
      "args": {
        "parent": "...",
        "filter": "...",
        "instanceDeadline": "...",
        "pageSize": "...",
        "pageToken": "..."
      },
      "result": "listResult"
    }
  }
]