probe SQL

describe_instance

Displays configuration and metadata about a Cloud SQL instance

Try it in Reliably

Activity as code

Below are the details and signature of the activity Python module.

Typeprobe
Modulechaosgcp.sql.probes
Namedescribe_instance
Returnmapping

Usage

JSON

{
  "name": "describe-instance",
  "type": "probe",
  "provider": {
    "type": "python",
    "module": "chaosgcp.sql.probes",
    "func": "describe_instance",
    "arguments": {
      "instance_id": ""
    }
  }
}

YAML

name: describe-instance
provider:
  arguments:
    instance_id: ''
  func: describe_instance
  module: chaosgcp.sql.probes
  type: python
type: probe

Arguments

NameTypeDefaultRequired
instance_idstringYes

Information such as instance name, IP address, region, the CA certificate and configuration settings will be displayed.

See https://cloud.google.com/sql/docs/postgres/admin-api/v1beta4/instances/get

Signature

def describe_instance(
        instance_id: str,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> Dict[str, Any]:
    pass

Related activities

  • action SQL

    trigger_failover

    Causes a high-availability Cloud SQL instance to failover
  • action SQL

    import_data

    Imports data into a Cloud SQL instance from a SQL dump or CSV file in Cloud Storage
  • action SQL

    export_data

    Exports data from a Cloud SQL instance to a Cloud Storage bucket