Cloud SQL Admin API (sqladmin:v1)

2023-10-16

1 new method | 1 updated method

Additions

    Methods

  • ▼ ▲ sql.instances.switchover

      Path: v1/projects/{project}/instances/{instance}/switchover

      Flat Path: v1/projects/{project}/instances/{instance}/switchover

      HTTP Method: POST

      Parameters:

        project

          Description: ID of the project that contains the replica.

          Location: path

          Required: Yes

          Type: string

        instance

          Description: Cloud SQL read replica instance name.

          Location: path

          Required: Yes

          Type: string

        dbTimeout

          Description: Optional. (MySQL only) Cloud SQL instance operations timeout, which is a sum of all database operations. Default value is 10 minutes and can be modified to a maximum value of 24 hours.

          Location: query

          Type: string

          Format: google-duration

      Parameter Order:

    • project
    • instance

      • Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/sqlservice.admin

      • Description: Switches over from the primary instance to the replica instance.

Updates

    Methods

  • ▼ ▲ sql.instances.promoteReplica

      Parameters:

        failover

          Description: Set to true if the promote operation should attempt to re-add the original primary as a replica when it comes back online. Otherwise, if this value is false or not set, the original primary will be a standalone instance.

          Location: query

          Type: boolean