2025-02-13
▼ ▲ sql.instances.delete
Parameters :
enableFinalBackup
Description : Flag to opt-in for final backup. By default, it is turned off.
Location : query
Type : boolean
finalBackupTtlDays
Description : Optional. Retention period of the final backup.
Location : query
Type : string
Format : int64
finalBackupExpiryTime
Description : Optional. Final Backup expiration time. Timestamp in UTC of when this resource is considered expired.
Location : query
Type : string
Format : google-datetime
finalBackupDescription
Description : Optional. The description of the final backup.
Location : query
Type : string
▼ ▲ sql.Backups.CreateBackup
Path : v1/{+parent}/backups
Flat Path : v1/projects/{projectsId}/backups
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource where this backup is created. Format: projects/{project}
Pattern : ^projects/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes :
Description : Creates a backup for a Cloud SQL instance. This API can be used only to create on-demand backups.
▼ ▲ sql.Backups.GetBackup
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/backups/{backupsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the backup to retrieve. Format: projects/{project}/backups/{backup}
Pattern : ^projects/[^/]+/backups/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Retrieves a resource containing information about a backup.
▼ ▲ sql.Backups.ListBackups
Path : v1/{+parent}/backups
Flat Path : v1/projects/{projectsId}/backups
HTTP Method : GET
Parameters :
parent
Description : Required. The parent that owns this collection of backups. Format: projects/{project}
Pattern : ^projects/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : The maximum number of backups to return per response. The service might return fewer backups than this value. If a value for this parameter isn't specified, then, at most, 500 backups are returned. The maximum value is 2,000. Any values that you set, which are greater than 2,000, are changed to 2,000.
Location : query
Type : integer
Format : int32
pageToken
Description : A page token, received from a previous `ListBackups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBackups` must match the call that provided the page token.
Location : query
Type : string
filter
Description : Multiple filter queries are separated by spaces. For example, 'instance:abc type:FINAL. You can filter by type, instance name, creation time or location.
Location : query
Type : string
Parameter Order : parent
Scopes :
Description : Lists all backups associated with the project.
▼ ▲ sql.Backups.UpdateBackup
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/backups/{backupsId}
HTTP Method : PATCH
Parameters :
name
Description : Output only. The resource name of the backup. Format: projects/{project}/backups/{backup}
Pattern : ^projects/[^/]+/backups/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : The list of fields that you can update. You can update only the description and retention period of the final backup.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes :
Description : Updates the retention period and description of the backup. You can use this API to update final backups only.
▼ ▲ sql.Backups.DeleteBackup
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/backups/{backupsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the backup to delete. Format: projects/{project}/backups/{backup}
Pattern : ^projects/[^/]+/backups/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Deletes the backup.
▼ ▲ sql.Backups.CreateBackup
Path : v1/{+parent}/backups
Flat Path : v1/projects/{projectsId}/backups
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource where this backup is created. Format: projects/{project}
Pattern : ^projects/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes :
Description : Creates a backup for a Cloud SQL instance. This API can be used only to create on-demand backups.
▼ ▲ sql.Backups.GetBackup
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/backups/{backupsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the backup to retrieve. Format: projects/{project}/backups/{backup}
Pattern : ^projects/[^/]+/backups/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Retrieves a resource containing information about a backup.
▼ ▲ sql.Backups.ListBackups
Path : v1/{+parent}/backups
Flat Path : v1/projects/{projectsId}/backups
HTTP Method : GET
Parameters :
parent
Description : Required. The parent that owns this collection of backups. Format: projects/{project}
Pattern : ^projects/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : The maximum number of backups to return per response. The service might return fewer backups than this value. If a value for this parameter isn't specified, then, at most, 500 backups are returned. The maximum value is 2,000. Any values that you set, which are greater than 2,000, are changed to 2,000.
Location : query
Type : integer
Format : int32
pageToken
Description : A page token, received from a previous `ListBackups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBackups` must match the call that provided the page token.
Location : query
Type : string
filter
Description : Multiple filter queries are separated by spaces. For example, 'instance:abc type:FINAL. You can filter by type, instance name, creation time or location.
Location : query
Type : string
Parameter Order : parent
Scopes :
Description : Lists all backups associated with the project.
▼ ▲ sql.Backups.UpdateBackup
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/backups/{backupsId}
HTTP Method : PATCH
Parameters :
name
Description : Output only. The resource name of the backup. Format: projects/{project}/backups/{backup}
Pattern : ^projects/[^/]+/backups/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : The list of fields that you can update. You can update only the description and retention period of the final backup.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes :
Description : Updates the retention period and description of the backup. You can use this API to update final backups only.
▼ ▲ sql.Backups.DeleteBackup
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/backups/{backupsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the backup to delete. Format: projects/{project}/backups/{backup}
Pattern : ^projects/[^/]+/backups/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Deletes the backup.
▼ ▲ sql.instances.delete
Parameters :
enableFinalBackup
Description : Flag to opt-in for final backup. By default, it is turned off.
Location : query
Type : boolean
finalBackupTtlDays
Description : Optional. Retention period of the final backup.
Location : query
Type : string
Format : int64
finalBackupExpiryTime
Description : Optional. Final Backup expiration time. Timestamp in UTC of when this resource is considered expired.
Location : query
Type : string
Format : google-datetime
finalBackupDescription
Description : Optional. The description of the final backup.
Location : query
Type : string