Method: googleapis.sqladmin.v1.connect.get

Retrieves connect settings about a Cloud SQL instance.

Arguments

Parameters
instance	string Required. Cloud SQL instance ID. This does not include the project ID.
project	string Required. Project ID of the project that contains the instance.
readTime	string (Timestamp format) Optional. Optional snapshot read timestamp to trade freshness for performance.

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

Subworkflow snippet

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

YAML

- get:
    call: googleapis.sqladmin.v1.connect.get
    args:
        instance: ...
        project: ...
        readTime: ...
    result: getResult

JSON

[
  {
    "get": {
      "call": "googleapis.sqladmin.v1.connect.get",
      "args": {
        "instance": "...",
        "project": "...",
        "readTime": "..."
      },
      "result": "getResult"
    }
  }
]