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