2022-02-02
▼ ▲ baremetalsolution.projects.locations.list
Flat Path : v2/projects/{projectsId}/locations
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameter Order : name
Parameters :
filter
Description : A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160).
Type : string
Location : query
name
Required : Yes
Type : string
Description : The resource that owns the locations collection, if applicable.
Location : path
Pattern : ^projects/[^/]+$
pageToken
Location : query
Description : A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Type : string
pageSize
Location : query
Format : int32
Type : integer
Description : The maximum number of results to return. If not set, the service selects a default.
Path : v2/{+name}/locations
Description : Lists information about the supported locations for this service.
▼ ▲ baremetalsolution.projects.locations.get
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Description : Resource name for the location.
Parameter Order : name
Flat Path : v2/projects/{projectsId}/locations/{locationsId}
Description : Gets information about a location.
Path : v2/{+name}
▼ ▲ baremetalsolution.projects.locations.snapshotSchedulePolicies.delete
HTTP Method : DELETE
Parameters :
name
Required : Yes
Description : Required. The name of the snapshot schedule policy to delete.
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/snapshotSchedulePolicies/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/snapshotSchedulePolicies/{snapshotSchedulePoliciesId}
Path : v2/{+name}
Parameter Order : name
Description : Delete a named snapshot schedule policy.
▼ ▲ baremetalsolution.projects.locations.snapshotSchedulePolicies.create
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Create a snapshot schedule policy in the specified project.
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/snapshotSchedulePolicies
Path : v2/{+parent}/snapshotSchedulePolicies
Parameters :
snapshotSchedulePolicyId
Location : query
Description : Required. Snapshot policy ID
Type : string
parent
Type : string
Required : Yes
Description : Required. The parent project and location containing the SnapshotSchedulePolicy.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
HTTP Method : POST
▼ ▲ baremetalsolution.projects.locations.snapshotSchedulePolicies.list
Parameter Order : parent
Description : List snapshot schedule policies in a given project and location.
Parameters :
filter
Location : query
Type : string
Description : List filter.
pageSize
Description : The maximum number of items to return.
Type : integer
Location : query
Format : int32
parent
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. The parent project containing the Snapshot Schedule Policies.
Location : path
Required : Yes
pageToken
Description : The next_page_token value returned from a previous List request, if any.
Type : string
Location : query
Path : v2/{+parent}/snapshotSchedulePolicies
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/snapshotSchedulePolicies
▼ ▲ baremetalsolution.projects.locations.snapshotSchedulePolicies.get
Description : Get details of a single snapshot schedule policy.
Path : v2/{+name}
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/snapshotSchedulePolicies/{snapshotSchedulePoliciesId}
HTTP Method : GET
Parameters :
name
Description : Required. Name of the resource.
Type : string
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/snapshotSchedulePolicies/[^/]+$
Parameter Order : name
▼ ▲ baremetalsolution.projects.locations.snapshotSchedulePolicies.patch
Parameters :
name
Required : Yes
Location : path
Description : Output only. The name of the snapshot schedule policy.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/snapshotSchedulePolicies/[^/]+$
updateMask
Format : google-fieldmask
Location : query
Description : Required. The list of fields to update.
Type : string
Description : Update a snapshot schedule policy in the specified project.
Path : v2/{+name}
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/snapshotSchedulePolicies/{snapshotSchedulePoliciesId}
▼ ▲ baremetalsolution.projects.locations.networks.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
pageToken
Description : A token identifying a page of results from the server.
Location : query
Type : string
pageSize
Format : int32
Location : query
Type : integer
Description : Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.
parent
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Location : path
Description : Required. Parent value for ListNetworksRequest.
filter
Description : List filter.
Type : string
Location : query
Path : v2/{+parent}/networks
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/networks
Description : List network in a given project and location.
Parameter Order : parent
HTTP Method : GET
▼ ▲ baremetalsolution.projects.locations.networks.patch
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/networks/[^/]+$
Required : Yes
Type : string
Location : path
Description : Output only. The resource name of this `Network`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/networks/{network}`
updateMask
Description : The list of fields to update. The only currently supported fields are: `labels`
Format : google-fieldmask
Type : string
Location : query
Parameter Order : name
Description : Update details of a single network.
Path : v2/{+name}
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/networks/{networksId}
HTTP Method : PATCH
▼ ▲ baremetalsolution.projects.locations.networks.get
HTTP Method : GET
Path : v2/{+name}
Parameter Order : name
Description : Get details of a single network.
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/networks/{networksId}
Parameters :
name
Type : string
Description : Required. Name of the resource.
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/networks/[^/]+$
▼ ▲ baremetalsolution.projects.locations.instances.get
Path : v2/{+name}
Parameters :
name
Description : Required. Name of the resource.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/instances/[^/]+$
Type : string
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}
Description : Get details about a single server.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
▼ ▲ baremetalsolution.projects.locations.instances.list
Parameter Order : parent
Parameters :
filter
Location : query
Type : string
Description : List filter.
parent
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. Parent value for ListInstancesRequest.
Location : path
pageToken
Location : query
Description : A token identifying a page of results from the server.
Type : string
pageSize
Type : integer
Format : int32
Location : query
Description : Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/instances
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v2/{+parent}/instances
HTTP Method : GET
Description : List servers in a given project and location.
▼ ▲ baremetalsolution.projects.locations.instances.patch
Description : Update details of a single server.
HTTP Method : PATCH
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
updateMask
Location : query
Description : The list of fields to update. The only currently supported fields are: `labels`
Type : string
Format : google-fieldmask
name
Type : string
Required : Yes
Description : Output only. The resource name of this `Instance`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/instances/{instance}`
Pattern : ^projects/[^/]+/locations/[^/]+/instances/[^/]+$
Location : path
Parameter Order : name
Path : v2/{+name}
▼ ▲ baremetalsolution.projects.locations.instances.reset
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:reset
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Path : v2/{+name}:reset
Parameter Order : name
Parameters :
name
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/instances/[^/]+$
Location : path
Description : Required. Name of the resource.
Description : Perform an ungraceful, hard reset on a server. Equivalent to shutting the power off and then turning it back on.
▼ ▲ baremetalsolution.projects.locations.volumes.patch
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/volumes/[^/]+$
Type : string
Description : Output only. The resource name of this `Volume`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/volumes/{volume}`
Location : path
Required : Yes
updateMask
Description : The list of fields to update. The only currently supported fields are: `snapshot_auto_delete_behavior` `snapshot_schedule_policy_name` 'labels'
Location : query
Type : string
Format : google-fieldmask
Description : Update details of a single storage volume.
Path : v2/{+name}
HTTP Method : PATCH
Parameter Order : name
▼ ▲ baremetalsolution.projects.locations.volumes.list
Path : v2/{+parent}/volumes
Parameter Order : parent
Description : List storage volumes in a given project and location.
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/volumes
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
pageToken
Type : string
Location : query
Description : A token identifying a page of results from the server.
pageSize
Location : query
Type : integer
Format : int32
Description : Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.
parent
Required : Yes
Type : string
Description : Required. Parent value for ListVolumesRequest.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
filter
Location : query
Type : string
Description : List filter.
HTTP Method : GET
▼ ▲ baremetalsolution.projects.locations.volumes.get
Description : Get details of a single storage volume.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/volumes/[^/]+$
Required : Yes
Location : path
Description : Required. Name of the resource.
Parameter Order : name
HTTP Method : GET
Path : v2/{+name}
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}
▼ ▲ baremetalsolution.projects.locations.volumes.snapshots.get
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots/{snapshotsId}
Parameter Order : name
Path : v2/{+name}
Description : Get details of a single storage volume snapshot.
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameters :
name
Location : path
Description : Required. Name of the resource.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/volumes/[^/]+/snapshots/[^/]+$
Type : string
▼ ▲ baremetalsolution.projects.locations.volumes.snapshots.list
HTTP Method : GET
Parameter Order : parent
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots
Description : List storage volume snapshots for given storage volume.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
pageSize
Format : int32
Type : integer
Description : Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.
Location : query
pageToken
Type : string
Location : query
Description : A token identifying a page of results from the server.
parent
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/volumes/[^/]+$
Location : path
Description : Required. Parent value for ListVolumesRequest.
Type : string
Path : v2/{+parent}/snapshots
▼ ▲ baremetalsolution.projects.locations.volumes.snapshots.restoreVolumeSnapshot
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots/{snapshotsId}:restoreVolumeSnapshot
HTTP Method : POST
Path : v2/{+volumeSnapshot}:restoreVolumeSnapshot
Parameters :
volumeSnapshot
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/volumes/[^/]+/snapshots/[^/]+$
Description : Required. Name of the resource.
Required : Yes
Location : path
Parameter Order : volumeSnapshot
Description : Restore a storage volume snapshot to its containing volume.
▼ ▲ baremetalsolution.projects.locations.volumes.snapshots.delete
HTTP Method : DELETE
Description : Deletes a storage volume snapshot for a given volume.
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots/{snapshotsId}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/volumes/[^/]+/snapshots/[^/]+$
Type : string
Description : Required. The name of the snapshot to delete.
Location : path
Required : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Path : v2/{+name}
▼ ▲ baremetalsolution.projects.locations.volumes.snapshots.create
Parameter Order : parent
Parameters :
parent
Required : Yes
Description : Required. The volume to snapshot.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/volumes/[^/]+$
Location : path
Description : Create a storage volume snapshot in a containing volume.
HTTP Method : POST
Path : v2/{+parent}/snapshots
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots
▼ ▲ baremetalsolution.projects.locations.volumes.luns.list
Parameter Order : parent
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/luns
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Type : string
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/volumes/[^/]+$
Description : Required. Parent value for ListLunsRequest.
pageSize
Description : Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.
Format : int32
Type : integer
Location : query
pageToken
Type : string
Location : query
Description : A token identifying a page of results from the server.
Path : v2/{+parent}/luns
Description : List storage volume luns for given storage volume.
HTTP Method : GET
▼ ▲ baremetalsolution.projects.locations.volumes.luns.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get details of a single storage logical unit number(LUN).
Parameter Order : name
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/luns/{lunsId}
Parameters :
name
Description : Required. Name of the resource.
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/volumes/[^/]+/luns/[^/]+$
Path : v2/{+name}
HTTP Method : GET