Cloud SQL Admin API (sqladmin:v1)

2026-09-17

5 removed methods

Deletions

    Methods
  • sql.workloadCaptures.stopReplay

      Scopes :

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

      Parameters :

        workloadId

          Location : path

          Description : Required. The ID of the workload to replay.

          Type : string

          Required : Yes

        instance

          Required : Yes

          Location : path

          Description : Required. Cloud SQL instance ID. This does not include the project ID.

          Type : string

        project

          Type : string

          Location : path

          Description : Required. Project ID of the project that contains the instance.

          Required : Yes

      Description : Stops executing a captured workload on the separate Cloud SQL instance.

      Path : v1/projects/{project}/instances/{instance}/workloadCaptures/{workloadId}:stopReplay

      Parameter Order :

    • project
    • instance
    • workloadId
    • Flat Path : v1/projects/{project}/instances/{instance}/workloadCaptures/{workloadId}:stopReplay

  • sql.workloadCaptures.stop

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/sqlservice.admin
    • Path : v1/projects/{project}/instances/{instance}/workloadCaptures:stop

      Flat Path : v1/projects/{project}/instances/{instance}/workloadCaptures:stop

      Parameter Order :

    • project
    • instance
    • Description : Stops capturing the query traffic and related operations executed on the primary instance.

      HTTP Method : POST

      Parameters :

        instance

          Type : string

          Required : Yes

          Description : Required. Cloud SQL instance ID. This does not include the project ID.

          Location : path

        project

          Location : path

          Description : Required. Project ID of the project that contains the instance.

          Required : Yes

          Type : string

  • sql.workloadCaptures.start

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/sqlservice.admin
    • Description : Starts capturing the SQL queries, transactions, and other operations executed on the primary instance. This traffic is securely stored and forms a "captured workload". This workload can be replayed later on a different instance to safely test performance impacts, database upgrades, configuration changes etc. before applying them to production.

      Path : v1/projects/{project}/instances/{instance}/workloadCaptures:start

      HTTP Method : POST

      Parameters :

        project

          Location : path

          Description : Required. Project ID of the project that contains the instance.

          Type : string

          Required : Yes

        instance

          Location : path

          Type : string

          Required : Yes

          Description : Required. Cloud SQL instance ID. This does not include the project ID.

      Parameter Order :

    • project
    • instance
    • Flat Path : v1/projects/{project}/instances/{instance}/workloadCaptures:start

  • sql.workloadCaptures.startReplay

      Flat Path : v1/projects/{project}/instances/{instance}/workloadCaptures/{workloadId}:startReplay

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/sqlservice.admin
    • Path : v1/projects/{project}/instances/{instance}/workloadCaptures/{workloadId}:startReplay

      Parameter Order :

    • project
    • instance
    • workloadId
    • Description : Starts executing a captured workload on a separate Cloud SQL instance provisioned for workload replay. This target instance simulates the production environment without affecting the primary instance.

      HTTP Method : POST

      Parameters :

        workloadId

          Description : Required. The ID of the workload to replay.

          Required : Yes

          Location : path

          Type : string

        instance

          Description : Required. Cloud SQL instance ID. This does not include the project ID.

          Type : string

          Location : path

          Required : Yes

        project

          Location : path

          Type : string

          Description : Required. Project ID of the project that contains the instance.

          Required : Yes

  • sql.workloadCaptures.list

      Scopes :

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

      Parameters :

        instance

          Required : Yes

          Location : path

          Type : string

          Description : Required. Cloud SQL instance ID. This does not include the project ID.

        project

          Required : Yes

          Type : string

          Location : path

          Description : Required. Project ID of the project that contains the instance.

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

      Parameter Order :

    • project
    • instance
    • Description : Lists all captured workloads associated with the instance.

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