2021-12-09
▼ ▲ baremetalsolution.projects.locations.get
Description: Gets information about a location.
Flat Path: v2/projects/{projectsId}/locations/{locationsId}
Parameters:
name
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Resource name for the location.
Required: Yes
Path: v2/{+name}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
▼ ▲ baremetalsolution.projects.locations.list
HTTP Method: GET
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists information about the supported locations for this service.
Flat Path: v2/projects/{projectsId}/locations
Parameters:
pageToken
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
Location: query
filter
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).
Type: string
name
Pattern: ^projects/[^/]+$
Type: string
Required: Yes
Location: path
Description: The resource that owns the locations collection, if applicable.
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
▼ ▲ baremetalsolution.projects.locations.snapshotSchedulePolicies.create
Parameter Order: parent
HTTP Method: POST
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
Type: string
Description: Required. Snapshot policy ID
parent
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Description: Required. The parent project and location containing the SnapshotSchedulePolicy.
▼ ▲ baremetalsolution.projects.locations.snapshotSchedulePolicies.patch
HTTP Method: PATCH
Parameter Order: name
Path: v2/{+name}
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/snapshotSchedulePolicies/{snapshotSchedulePoliciesId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Update a snapshot schedule policy in the specified project.
Parameters:
updateMask
Format: google-fieldmask
Type: string
Description: Required. The list of fields to update.
Location: query
name
Location: path
Required: Yes
Description: Output only. The name of the snapshot schedule policy.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/snapshotSchedulePolicies/[^/]+$
▼ ▲ baremetalsolution.projects.locations.snapshotSchedulePolicies.list
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/snapshotSchedulePolicies
HTTP Method: GET
Parameter Order: parent
Path: v2/{+parent}/snapshotSchedulePolicies
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: List snapshot schedule policies in a given project and location.
Parameters:
pageToken
Location: query
Description: The next_page_token value returned from a previous List request, if any.
Type: string
parent
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The parent project containing the Snapshot Schedule Policies.
pageSize
Type: integer
Location: query
Format: int32
Description: The maximum number of items to return.
▼ ▲ baremetalsolution.projects.locations.snapshotSchedulePolicies.delete
Path: v2/{+name}
HTTP Method: DELETE
Parameters:
name
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/snapshotSchedulePolicies/[^/]+$
Description: Required. The name of the snapshot schedule policy to delete.
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/snapshotSchedulePolicies/{snapshotSchedulePoliciesId}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Delete a named snapshot schedule policy.
▼ ▲ baremetalsolution.projects.locations.snapshotSchedulePolicies.get
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/snapshotSchedulePolicies/{snapshotSchedulePoliciesId}
Description: Get details of a single snapshot schedule policy.
Parameter Order: name
Path: v2/{+name}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/snapshotSchedulePolicies/[^/]+$
Description: Required. Name of the resource.
Required: Yes
Type: string
Location: path
▼ ▲ baremetalsolution.projects.locations.instances.reset
Parameter Order: name
HTTP Method: POST
Description: Perform an ungraceful, hard reset on a server. Equivalent to shutting the power off and then turning it back on.
Parameters:
name
Required: Yes
Description: Required. Name of the resource.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/instances/[^/]+$
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v2/{+name}:reset
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:reset
▼ ▲ baremetalsolution.projects.locations.instances.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/instances/[^/]+$
Description: Required. Name of the resource.
Required: Yes
Location: path
Parameter Order: name
Description: Get details about a single server.
HTTP Method: GET
Path: v2/{+name}
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}
▼ ▲ baremetalsolution.projects.locations.instances.list
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/instances
Path: v2/{+parent}/instances
Parameters:
pageToken
Location: query
Description: A token identifying a page of results from the server.
Type: string
parent
Description: Required. Parent value for ListInstancesRequest.
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
pageSize
Type: integer
Description: Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
Format: int32
Location: query
HTTP Method: GET
Description: List servers in a given project and location.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
▼ ▲ baremetalsolution.projects.locations.volumes.list
HTTP Method: GET
Parameter Order: parent
Description: List storage volumes in a given project and location.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
parent
Location: path
Required: Yes
Type: string
Description: Required. Parent value for ListVolumesRequest.
Pattern: ^projects/[^/]+/locations/[^/]+$
pageSize
Location: query
Format: int32
Type: integer
Description: Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken
Type: string
Location: query
Description: A token identifying a page of results from the server.
Path: v2/{+parent}/volumes
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/volumes
▼ ▲ baremetalsolution.projects.locations.volumes.get
HTTP Method: GET
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}
Description: Get details of a single storage volume.
Path: v2/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
name
Required: Yes
Description: Required. Name of the resource.
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/volumes/[^/]+$
▼ ▲ baremetalsolution.projects.locations.volumes.patch
Path: v2/{+name}
Parameters:
name
Required: Yes
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
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`
Format: google-fieldmask
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}
Parameter Order: name
HTTP Method: PATCH
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Update details of a single storage volume.
▼ ▲ baremetalsolution.projects.locations.volumes.luns.get
Description: Get details of a single storage lun.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
HTTP Method: GET
Parameters:
name
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/volumes/[^/]+/luns/[^/]+$
Location: path
Description: Required. Name of the resource.
Path: v2/{+name}
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/luns/{lunsId}
▼ ▲ baremetalsolution.projects.locations.volumes.luns.list
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/luns
Description: List storage volume luns for given storage volume.
Parameters:
parent
Required: Yes
Description: Required. Parent value for ListLunsRequest.
Pattern: ^projects/[^/]+/locations/[^/]+/volumes/[^/]+$
Type: string
Location: path
pageToken
Type: string
Location: query
Description: A token identifying a page of results from the server.
pageSize
Description: Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.
Format: int32
Location: query
Type: integer
HTTP Method: GET
Path: v2/{+parent}/luns
Parameter Order: parent
▼ ▲ baremetalsolution.projects.locations.volumes.snapshots.list
Parameters:
pageSize
Description: Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.
Location: query
Format: int32
Type: integer
parent
Pattern: ^projects/[^/]+/locations/[^/]+/volumes/[^/]+$
Type: string
Description: Required. Parent value for ListVolumesRequest.
Required: Yes
Location: path
pageToken
Location: query
Description: A token identifying a page of results from the server.
Type: string
Description: List storage volume snapshots for given storage volume.
HTTP Method: GET
Parameter Order: parent
Path: v2/{+parent}/snapshots
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots
▼ ▲ baremetalsolution.projects.locations.volumes.snapshots.restoreVolumeSnapshot
Parameters:
volumeSnapshot
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/volumes/[^/]+/snapshots/[^/]+$
Location: path
Description: Required. Name of the resource.
Required: Yes
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots/{snapshotsId}:restoreVolumeSnapshot
Parameter Order: volumeSnapshot
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Restore a storage volume snapshot to its containing volume.
HTTP Method: POST
Path: v2/{+volumeSnapshot}:restoreVolumeSnapshot
▼ ▲ baremetalsolution.projects.locations.volumes.snapshots.get
Description: Get details of a single storage volume snapshot.
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots/{snapshotsId}
Path: v2/{+name}
HTTP Method: GET
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Description: Required. Name of the resource.
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/volumes/[^/]+/snapshots/[^/]+$
▼ ▲ baremetalsolution.projects.locations.volumes.snapshots.delete
Parameters:
name
Location: path
Description: Required. The name of the snapshot to delete.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/volumes/[^/]+/snapshots/[^/]+$
Required: Yes
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Description: Deletes a storage volume snapshot for a given volume.
Path: v2/{+name}
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots/{snapshotsId}
▼ ▲ baremetalsolution.projects.locations.volumes.snapshots.create
Path: v2/{+parent}/snapshots
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Create a storage volume snapshot in a containing volume.
Parameter Order: parent
HTTP Method: POST
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots
Parameters:
parent
Location: path
Description: Required. The volume to snapshot.
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/volumes/[^/]+$
▼ ▲ baremetalsolution.projects.locations.operations.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v2/{+name}
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Parameters:
name
Description: The name of the operation resource.
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
HTTP Method: GET
Parameter Order: name
Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ baremetalsolution.projects.locations.operations.delete
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location: path
Type: string
Description: The name of the operation resource to be deleted.
Required: Yes
Path: v2/{+name}
Description: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
HTTP Method: DELETE
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
▼ ▲ baremetalsolution.projects.locations.operations.list
HTTP Method: GET
Path: v2/{+name}/operations
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/operations
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameters:
pageToken
Description: The standard list page token.
Type: string
Location: query
name
Required: Yes
Location: path
Description: The name of the operation's parent resource.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
filter
Type: string
Location: query
Description: The standard list filter.
pageSize
Description: The standard list page size.
Format: int32
Type: integer
Location: query
Parameter Order: name
▼ ▲ baremetalsolution.projects.locations.operations.cancel
Description: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location: path
Type: string
Description: The name of the operation resource to be cancelled.
Parameter Order: name
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
Path: v2/{+name}:cancel
HTTP Method: POST
▼ ▲ baremetalsolution.projects.locations.networks.list
Description: List network in a given project and location.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/networks
Path: v2/{+parent}/networks
HTTP Method: GET
Parameters:
pageToken
Location: query
Type: string
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
Description: Required. Parent value for ListNetworksRequest.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Required: Yes
Parameter Order: parent
▼ ▲ baremetalsolution.projects.locations.networks.get
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/networks/{networksId}
Description: Get details of a single network.
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v2/{+name}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/networks/[^/]+$
Location: path
Description: Required. Name of the resource.
Type: string
Required: Yes