2026-11-15
▼ ▲ file.projects.locations.volumePools.volumes.delete
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Parameters :
name
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/volumePools/[^/]+/volumes/[^/]+$
Type : string
Description : Required. The volume resource name, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}`.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/volumePools/{volumePoolsId}/volumes/{volumesId}
Path : v1/{+name}
Description : Deletes a volume.
HTTP Method : DELETE
▼ ▲ file.projects.locations.volumePools.volumes.unfreeze
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Unfreezes a volume.
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/volumePools/{volumePoolsId}/volumes/{volumesId}:unfreeze
Path : v1/{+name}:unfreeze
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/volumePools/[^/]+/volumes/[^/]+$
Type : string
Description : Required. The name of the volume to unfreeze. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}`.
Location : path
Required : Yes
▼ ▲ file.projects.locations.volumePools.volumes.patch
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
Parameters :
updateMask
Description : Required. Mask of fields to update. At least one path must be supplied in this field.
Location : query
Format : google-fieldmask
Type : string
name
Pattern : ^projects/[^/]+/locations/[^/]+/volumePools/[^/]+/volumes/[^/]+$
Description : Identifier. The resource name of the volume, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}`.
Type : string
Location : path
Required : Yes
Description : Updates the settings of a specific volume.
HTTP Method : PATCH
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/volumePools/{volumePoolsId}/volumes/{volumesId}
▼ ▲ file.projects.locations.volumePools.volumes.list
Path : v1/{+parent}/volumes
Description : Lists all volumes for a specified volume pool.
Parameters :
orderBy
Location : query
Type : string
Description : Optional. Sort results. Supported values are "name", "name desc" or "" (unsorted).
pageToken
Type : string
Description : Optional. The next_page_token value to use if there are additional results to retrieve for this list request.
Location : query
pageSize
Description : Optional. The maximum number of items to return.
Type : integer
Location : query
Format : int32
parent
Pattern : ^projects/[^/]+/locations/[^/]+/volumePools/[^/]+$
Description : Required. The volume pool for which to retrieve volume information, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`.
Type : string
Location : path
Required : Yes
filter
Location : query
Description : Optional. List filter.
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/volumePools/{volumePoolsId}/volumes
▼ ▲ file.projects.locations.volumePools.volumes.createFromSource
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a volume in a volume pool from an existing data source (such as a Filestore backup).
Parameters :
parent
Description : Required. The parent resource where this volume will be created. Format: projects/{project}/locations/{location}/volumePools/{volume_pool}
Pattern : ^projects/[^/]+/locations/[^/]+/volumePools/[^/]+$
Type : string
Required : Yes
Location : path
Path : v1/{+parent}/volumes:createFromSource
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/volumePools/{volumePoolsId}/volumes:createFromSource
HTTP Method : POST
▼ ▲ file.projects.locations.volumePools.volumes.get
Description : Gets the details of a specific volume.
HTTP Method : GET
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/volumePools/{volumePoolsId}/volumes/{volumesId}
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/volumePools/[^/]+/volumes/[^/]+$
Description : Required. The volume resource name, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}`.
Location : path
Required : Yes
Path : v1/{+name}
▼ ▲ file.projects.locations.volumePools.volumes.create
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/volumePools/{volumePoolsId}/volumes
Path : v1/{+parent}/volumes
HTTP Method : POST
Description : Creates a volume.
Parameters :
volumeId
Location : query
Type : string
Description : Required. The ID to use for the volume. The ID must be unique within the specified volume pool.
parent
Description : Required. The parent volume pool path, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`.
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/volumePools/[^/]+$
Location : path
Parameter Order : parent
▼ ▲ file.projects.locations.volumePools.delete
Path : v1/{+name}
HTTP Method : DELETE
Parameter Order : name
Description : Deletes a volume pool.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/volumePools/{volumePoolsId}
Parameters :
force
Location : query
Description : Optional. If set to `true`, the volume pool is deleted even if it has volumes, and its volumes are deleted with it. Otherwise, the request fails if the volume pool has any volumes.
Type : boolean
name
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/volumePools/[^/]+$
Location : path
Description : Required. The volume pool resource name, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`.
▼ ▲ file.projects.locations.volumePools.get
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/volumePools/[^/]+$
Type : string
Location : path
Required : Yes
Description : Required. The volume pool resource name, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/volumePools/{volumePoolsId}
Parameter Order : name
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the details of a specific volume pool.
Path : v1/{+name}
▼ ▲ file.projects.locations.volumePools.create
Parameters :
volumePoolId
Description : Required. The ID to use for the volume pool, which will become the final component of the volume pool's resource name.
Location : query
Type : string
parent
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. The project and location for which to create the volume pool, in the format `projects/{project}/locations/{location}`.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+parent}/volumePools
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/volumePools
HTTP Method : POST
Parameter Order : parent
Description : Creates a volume pool.
▼ ▲ file.projects.locations.volumePools.patch
HTTP Method : PATCH
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/volumePools/{volumePoolsId}
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : Identifier. The resource name of the volume pool, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`.
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/volumePools/[^/]+$
updateMask
Description : Optional. Mask of fields to update. At least one path must be supplied in this field.
Format : google-fieldmask
Location : query
Type : string
Description : Updates the settings of a specific volume pool.
Path : v1/{+name}
▼ ▲ file.projects.locations.volumePools.list
Parameter Order : parent
Path : v1/{+parent}/volumePools
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/volumePools
Parameters :
orderBy
Type : string
Location : query
Description : Optional. Sort results. Supported values are "name", "name desc" or "" (unsorted).
pageToken
Location : query
Type : string
Description : Optional. The next_page_token value to use if there are additional results to retrieve for this list request.
pageSize
Type : integer
Location : query
Description : Optional. The maximum number of items to return.
Format : int32
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Location : path
Description : Required. The project and location for which to retrieve volume pool information, in the format `projects/{project}/locations/{location}`. To retrieve volume pool information for all locations, use "-" as the value of `{location}`.
Required : Yes
filter
Location : query
Description : Optional. List filter.
Type : string
Description : Lists all volume pools in a project for either a specified location or for all locations.
HTTP Method : GET