Skip to content
Proud to collaborate with Microsoft for Startups

gcp.sql.backup.list ​

List Cloud SQL backup runs for an instance and surface the latest successful one.

List Cloud SQL backup runs without mutating resources.

Overview ​

PropertyValue
Workflow typeLinear
LibraryBase-gcp
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidYes—GCP CloudConnection UUID.
project_idstringNo—GCP project override.
regionstringNo—Cloud SQL region used for credential scoping.
instance_idstringYes—Cloud SQL instance id.
page_sizeintegerNo—Provider page size.
max_resultsintegerNo—Maximum backup runs to collect across pages.
only_successfulbooleanNo—Return only backup runs whose status is SUCCESSFUL.

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidNo—Echoed connection UUID.
project_idstringNo—Effective project.
regionstringNo—Cloud SQL region used for credential scoping.
instance_idstringNo—Cloud SQL instance id.
page_sizeintegerNo—Provider page size.
max_resultsintegerNo—Maximum backup runs to collect across pages.
only_successfulbooleanNo—Return only backup runs whose status is SUCCESSFUL.
backup_runslistNo—Sanitized backup run records.
backup_run_countintegerNo—Number of backup runs returned.
latest_successful_backup_run_idstringNo—Backup run id of the newest SUCCESSFUL run; feed to gcp.sql.backup.restore.
latest_successful_backupjsonNo—Newest SUCCESSFUL backup run record.
failure_reasonstringNo—Human-readable failure reason.
failed_stepstringNo—Failed logical step.
failed_layerjsonNo—Engine failed layer.
failed_at_statestringNo—State where failure occurred.
errorstringNo—Error message.
error_typestringNo—Error class.

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—preflight—
listingNoNo—complete—
preflightingNoNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingpreflightpreflighting—
preflightingexecutelisting—
listingcompletecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "gcp.sql.backup.list",
  "initial_data": {
    "connection_uuid": "value",
    "instance_id": "value"
  }
}