2026-09-16
▼ ▲ sql.workloadCaptures.stop
Parameters :
instance
Location : path
Required : Yes
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.
Flat Path : sql/v1beta4/projects/{project}/instances/{instance}/workloadCaptures:stop
Path : sql/v1beta4/projects/{project}/instances/{instance}/workloadCaptures:stop
HTTP Method : POST
Scopes :
Parameter Order :
Description : Stops capturing the query traffic and related operations executed on the primary instance.
▼ ▲ sql.workloadCaptures.stopReplay
Parameter Order :
HTTP Method : POST
Scopes :
Parameters :
workloadId
Required : Yes
Type : string
Location : path
Description : Required. The ID of the workload to replay.
project
Type : string
Required : Yes
Description : Required. Project ID of the project that contains the instance.
Location : path
instance
Required : Yes
Type : string
Description : Required. Cloud SQL instance ID. This does not include the project ID.
Location : path
Description : Stops executing a captured workload on the separate Cloud SQL instance.
Flat Path : sql/v1beta4/projects/{project}/instances/{instance}/workloadCaptures/{workloadId}:stopReplay
Path : sql/v1beta4/projects/{project}/instances/{instance}/workloadCaptures/{workloadId}:stopReplay
▼ ▲ sql.workloadCaptures.startReplay
Scopes :
HTTP Method : POST
Flat Path : sql/v1beta4/projects/{project}/instances/{instance}/workloadCaptures/{workloadId}:startReplay
Path : sql/v1beta4/projects/{project}/instances/{instance}/workloadCaptures/{workloadId}:startReplay
Parameters :
instance
Location : path
Description : Required. Cloud SQL instance ID. This does not include the project ID.
Required : Yes
Type : string
workloadId
Location : path
Type : string
Required : Yes
Description : Required. The ID of the workload to replay.
project
Required : Yes
Type : string
Description : Required. Project ID of the project that contains the instance.
Location : path
Parameter Order :
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.
▼ ▲ sql.workloadCaptures.start
HTTP Method : POST
Flat Path : sql/v1beta4/projects/{project}/instances/{instance}/workloadCaptures:start
Path : sql/v1beta4/projects/{project}/instances/{instance}/workloadCaptures:start
Scopes :
Parameters :
project
Description : Required. Project ID of the project that contains the instance.
Required : Yes
Type : string
Location : path
instance
Type : string
Required : Yes
Description : Required. Cloud SQL instance ID. This does not include the project ID.
Location : path
Parameter Order :
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.
▼ ▲ sql.workloadCaptures.list
Scopes :
Description : Lists all captured workloads associated with the instance.
Parameter Order :
Flat Path : sql/v1beta4/projects/{project}/instances/{instance}/workloadCaptures
Path : sql/v1beta4/projects/{project}/instances/{instance}/workloadCaptures
HTTP Method : GET
Parameters :
project
Required : Yes
Location : path
Type : string
Description : Required. Project ID of the project that contains the instance.
instance
Type : string
Location : path
Description : Required. Cloud SQL instance ID. This does not include the project ID.
Required : Yes