2024-11-17
▼ ▲ redis.projects.locations.clusters.backup
Path : v1beta1/{+name}:backup
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:backup
HTTP Method : POST
Parameters :
name
Description : Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP region.
Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Backup Redis Cluster. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation.
▼ ▲ redis.projects.locations.backupCollections.list
Path : v1beta1/{+parent}/backupCollections
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/backupCollections
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the backupCollection location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's `next_page_token` to determine if there are more clusters left to be queried.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The `next_page_token` value returned from a previous [ListBackupCollections] request, if any.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists all backup collections owned by a consumer project in either the specified location (region) or all locations. If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated.
▼ ▲ redis.projects.locations.backupCollections.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/backupCollections/{backupCollectionsId}
HTTP Method : GET
Parameters :
name
Description : Required. Redis backupCollection resource name using the form: `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}` where `location_id` refers to a GCP region.
Pattern : ^projects/[^/]+/locations/[^/]+/backupCollections/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get a backup collection.
▼ ▲ redis.projects.locations.backupCollections.backups.list
Path : v1beta1/{+parent}/backups
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/backupCollections/{backupCollectionsId}/backups
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the backupCollection using the form: `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/backupCollections/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's `next_page_token` to determine if there are more clusters left to be queried.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The `next_page_token` value returned from a previous [ListBackupCollections] request, if any.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists all backups owned by a backup collection.
▼ ▲ redis.projects.locations.backupCollections.backups.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/backupCollections/{backupCollectionsId}/backups/{backupsId}
HTTP Method : GET
Parameters :
name
Description : Required. Redis backup resource name using the form: `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/backupCollections/[^/]+/backups/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the details of a specific backup.
▼ ▲ redis.projects.locations.backupCollections.backups.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/backupCollections/{backupCollectionsId}/backups/{backupsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. Redis backup resource name using the form: `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/backupCollections/[^/]+/backups/[^/]+$
Location : path
Required : Yes
Type : string
requestId
Description : Optional. Idempotent request UUID.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a specific backup.
▼ ▲ redis.projects.locations.backupCollections.backups.export
Path : v1beta1/{+name}:export
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/backupCollections/{backupCollectionsId}/backups/{backupsId}:export
HTTP Method : POST
Parameters :
name
Description : Required. Redis backup resource name using the form: `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/backupCollections/[^/]+/backups/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Exports a specific backup to a customer target Cloud Storage URI.