2023-04-28
▼ ▲ gkeonprem.projects.locations.get
Path: v1/{+name}
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Description: Gets information about a location.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}
Parameters:
name
Location: path
Required: Yes
Description: Resource name for the location.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
▼ ▲ gkeonprem.projects.locations.list
Flat Path: v1/projects/{projectsId}/locations
HTTP Method: GET
Parameter Order: name
Description: Lists information about the supported locations for this service.
Path: v1/{+name}/locations
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).
Location: query
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.
name
Type: string
Location: path
Pattern: ^projects/[^/]+$
Description: The resource that owns the locations collection, if applicable.
Required: Yes
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
▼ ▲ gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.operations.list
Parameters:
pageToken
Type: string
Description: The standard list page token.
Location: query
name
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+/vmwareNodePools/[^/]+$
Description: The name of the operation's parent resource.
filter
Description: The standard list filter.
Type: string
Location: query
pageSize
Location: query
Format: int32
Description: The standard list page size.
Type: integer
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
HTTP Method: GET
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools/{vmwareNodePoolsId}/operations
Path: v1/{+name}/operations
▼ ▲ gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.operations.get
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools/{vmwareNodePoolsId}/operations/{operationsId}
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.
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Location: path
Description: The name of the operation resource.
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+/vmwareNodePools/[^/]+/operations/[^/]+$
Parameter Order: name
HTTP Method: GET
▼ ▲ gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.get
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+/vmwareNodePools/[^/]+$
Type: string
Description: Required. The name of the node pool to retrieve. projects/{project}/locations/{location}/vmwareClusters/{cluster}/vmwareNodePools/{nodepool}
Location: path
Parameter Order: name
Description: Gets details of a single VMware node pool.
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools/{vmwareNodePoolsId}
▼ ▲ gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.enroll
Description: Enrolls a VMware node pool to Anthos On-Prem API
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Path: v1/{+parent}/vmwareNodePools:enroll
HTTP Method: POST
Parameters:
parent
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+$
Description: Required. The parent resource where the node pool is enrolled in.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools:enroll
▼ ▲ gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.unenroll
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}:unenroll
Parameters:
etag
Description: The current etag of the VMware node pool. If an etag is provided and does not match the current etag of node pool, deletion will be blocked and an ABORTED error will be returned.
Type: string
Location: query
validateOnly
Description: If set, only validate the request, but do not actually unenroll the node pool.
Type: boolean
Location: query
name
Location: path
Required: Yes
Description: Required. The name of the node pool to unenroll. Format: projects/{project}/locations/{location}/vmwareClusters/{cluster}/vmwareNodePools/{nodepool}
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+/vmwareNodePools/[^/]+$
HTTP Method: DELETE
Parameter Order: name
Description: Unenrolls a VMware node pool to Anthos On-Prem API
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools/{vmwareNodePoolsId}:unenroll
▼ ▲ gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.delete
Description: Deletes a single VMware node pool.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools/{vmwareNodePoolsId}
Parameters:
validateOnly
Location: query
Description: If set, only validate the request, but do not actually delete the node pool.
Type: boolean
allowMissing
Location: query
Description: If set to true, and the VMware node pool is not found, the request will succeed but no action will be taken on the server and return a completed LRO.
Type: boolean
etag
Description: The current etag of the VmwareNodePool. If an etag is provided and does not match the current etag of the node pool, deletion will be blocked and an ABORTED error will be returned.
Type: string
Location: query
ignoreErrors
Location: query
Description: If set to true, the deletion of a VMware node pool resource will succeed even if errors occur during deletion. This parameter can be used when you want to delete GCP's node pool resource and you've already deleted the on-prem admin cluster that hosted your node pool. WARNING: Using this parameter when your user cluster still exists may result in a deleted GCP node pool but an existing on-prem node pool.
Type: boolean
name
Description: Required. The name of the node pool to delete. Format: projects/{project}/locations/{location}/vmwareClusters/{cluster}/vmwareNodePools/{nodepool}
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+/vmwareNodePools/[^/]+$
Type: string
HTTP Method: DELETE
Path: v1/{+name}
▼ ▲ gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.setIamPolicy
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools/{vmwareNodePoolsId}:setIamPolicy
Path: v1/{+resource}:setIamPolicy
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Parameters:
resource
Type: string
Required: Yes
Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+/vmwareNodePools/[^/]+$
Location: path
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
▼ ▲ gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.testIamPermissions
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+/vmwareNodePools/[^/]+$
Location: path
Type: string
Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required: Yes
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameter Order: resource
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools/{vmwareNodePoolsId}:testIamPermissions
Path: v1/{+resource}:testIamPermissions
▼ ▲ gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.create
Description: Creates a new VMware node pool in a given project, location and VMWare cluster.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Parameters:
validateOnly
Description: If set, only validate the request, but do not actually create the node pool.
Location: query
Type: boolean
vmwareNodePoolId
Type: string
Location: query
Description: The ID to use for the node pool, which will become the final component of the node pool's resource name. This value must be up to 40 characters and follow RFC-1123 (https://tools.ietf.org/html/rfc1123) format. The value must not be permitted to be a UUID (or UUID-like: anything matching /^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$/i).
parent
Type: string
Location: path
Description: Required. The parent resource where this node pool will be created. projects/{project}/locations/{location}/vmwareClusters/{cluster}
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+$
Required: Yes
Path: v1/{+parent}/vmwareNodePools
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools
HTTP Method: POST
▼ ▲ gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.list
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools
Parameter Order: parent
Description: Lists VMware node pools in a given project, location and VMWare cluster.
HTTP Method: GET
Parameters:
pageSize
Format: int32
Type: integer
Description: The maximum number of node pools to return. The service may return fewer than this value. If unspecified, at most 50 node pools will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location: query
parent
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+$
Description: Required. The parent, which owns this collection of node pools. Format: projects/{project}/locations/{location}/vmwareClusters/{vmwareCluster}
pageToken
Location: query
Description: A page token, received from a previous `ListVmwareNodePools` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListVmwareNodePools` must match the call that provided the page token.
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/vmwareNodePools
▼ ▲ gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.getIamPolicy
Parameters:
resource
Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+/vmwareNodePools/[^/]+$
Type: string
Location: path
options.requestedPolicyVersion
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Format: int32
Location: query
Type: integer
Path: v1/{+resource}:getIamPolicy
Parameter Order: resource
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools/{vmwareNodePoolsId}:getIamPolicy
▼ ▲ gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.patch
Parameters:
validateOnly
Description: Validate the request without actually doing any updates.
Location: query
Type: boolean
updateMask
Description: Required. Field mask is used to specify the fields to be overwritten in the VMwareNodePool resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all populated fields in the VMwareNodePool message will be updated. Empty fields will be ignored unless a field mask is used.
Format: google-fieldmask
Type: string
Location: query
name
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+/vmwareNodePools/[^/]+$
Required: Yes
Location: path
Description: Immutable. The resource name of this node pool.
Type: string
HTTP Method: PATCH
Description: Updates the parameters of a single VMware node pool.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools/{vmwareNodePoolsId}
▼ ▲ gkeonprem.projects.locations.vmwareClusters.operations.list
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/operations
Path: v1/{+name}/operations
HTTP Method: GET
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Parameters:
filter
Type: string
Description: The standard list filter.
Location: query
pageToken
Location: query
Description: The standard list page token.
Type: string
pageSize
Description: The standard list page size.
Format: int32
Type: integer
Location: query
name
Description: The name of the operation's parent resource.
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+$
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
▼ ▲ gkeonprem.projects.locations.vmwareClusters.operations.get
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/operations/{operationsId}
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
HTTP Method: GET
Parameters:
name
Type: string
Description: The name of the operation resource.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+/operations/[^/]+$
Required: Yes
▼ ▲ gkeonprem.projects.locations.vmwareClusters.patch
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}
Parameters:
name
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+$
Description: Immutable. The VMware user cluster resource name.
Location: path
validateOnly
Location: query
Description: Validate the request without actually doing any updates.
Type: boolean
updateMask
Description: Required. Field mask is used to specify the fields to be overwritten in the VMwareCluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all populated fields in the VmwareCluster message will be updated. Empty fields will be ignored unless a field mask is used.
Location: query
Format: google-fieldmask
Type: string
HTTP Method: PATCH
Parameter Order: name
Path: v1/{+name}
Description: Updates the parameters of a single VMware cluster.
▼ ▲ gkeonprem.projects.locations.vmwareClusters.testIamPermissions
Path: v1/{+resource}:testIamPermissions
Parameter Order: resource
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}:testIamPermissions
Parameters:
resource
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+$
Required: Yes
Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Location: path
▼ ▲ gkeonprem.projects.locations.vmwareClusters.create
Path: v1/{+parent}/vmwareClusters
Parameters:
validateOnly
Description: Validate the request without actually doing any updates.
Location: query
Type: boolean
parent
Type: string
Location: path
Description: Required. The parent of the project and location where this cluster is created in. Format: "projects/{project}/locations/{location}"
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
vmwareClusterId
Description: User provided identifier that is used as part of the resource name; This value must be up to 40 characters and follow RFC-1123 (https://tools.ietf.org/html/rfc1123) format.
Type: string
Location: query
Description: Creates a new VMware cluster in a given project and location.
Parameter Order: parent
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters
▼ ▲ gkeonprem.projects.locations.vmwareClusters.setIamPolicy
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}:setIamPolicy
HTTP Method: POST
Path: v1/{+resource}:setIamPolicy
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+$
Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Location: path
Required: Yes
▼ ▲ gkeonprem.projects.locations.vmwareClusters.getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}:getIamPolicy
Path: v1/{+resource}:getIamPolicy
Parameters:
resource
Required: Yes
Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+$
Location: path
options.requestedPolicyVersion
Location: query
Format: int32
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Type: integer
Parameter Order: resource
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
HTTP Method: GET
▼ ▲ gkeonprem.projects.locations.vmwareClusters.delete
Parameter Order: name
Parameters:
force
Description: If set to true, any node pools from the cluster will also be deleted.
Type: boolean
Location: query
etag
Description: The current etag of the VMware cluster. If an etag is provided and does not match the current etag of the cluster, deletion will be blocked and an ABORTED error will be returned.
Type: string
Location: query
allowMissing
Type: boolean
Description: If set to true, and the VMware cluster is not found, the request will succeed but no action will be taken on the server and return a completed LRO.
Location: query
ignoreErrors
Location: query
Type: boolean
Description: If set to true, the deletion of a VMware user cluster resource will succeed even if errors occur during deletion. This parameter can be used when you want to delete GCP's cluster resource and the on-prem admin cluster that hosts your user cluster is disconnected / unreachable or deleted. WARNING: Using this parameter when your user cluster still exists may result in a deleted GCP user cluster but an existing on-prem user cluster.
name
Required: Yes
Description: Required. Name of the VMware user cluster to be deleted. Format: "projects/{project}/locations/{location}/vmwareClusters/{vmware_cluster}"
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+$
Location: path
validateOnly
Location: query
Description: Validate the request without actually doing any updates.
Type: boolean
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}
HTTP Method: DELETE
Description: Deletes a single VMware Cluster.
Path: v1/{+name}
▼ ▲ gkeonprem.projects.locations.vmwareClusters.list
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters
HTTP Method: GET
Description: Lists VMware Clusters in a given project and location.
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/vmwareClusters
Parameters:
pageToken
Type: string
Description: A token identifying a page of results the server should return.
Location: query
pageSize
Location: query
Description: Requested page size. Server may return fewer items than requested. If unspecified, at most 50 clusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Type: integer
Format: int32
filter
Type: string
Location: query
Description: A resource filtering expression following https://google.aip.dev/160. When non-empty, only resource's whose attributes field matches the filter are returned.
view
Enum Descriptions:
Enum:
Type: string
Location: query
Description: View for VMware clusters. When `BASIC` is specified, only the cluster resource name and admin cluster membership are returned. The default/unset value `CLUSTER_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete cluster configuration details.
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
Description: Required. The parent of the project and location where the clusters are listed in. Format: "projects/{project}/locations/{location}"
▼ ▲ gkeonprem.projects.locations.vmwareClusters.get
Description: Gets details of a single VMware Cluster.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}
Parameters:
name
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+$
Description: Required. Name of the VMware user cluster to be returned. Format: "projects/{project}/locations/{location}/vmwareClusters/{vmware_cluster}"
Type: string
Path: v1/{+name}
HTTP Method: GET
▼ ▲ gkeonprem.projects.locations.vmwareClusters.enroll
Parameter Order: parent
Path: v1/{+parent}/vmwareClusters:enroll
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters:enroll
HTTP Method: POST
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Type: string
Location: path
Description: Required. The parent of the project and location where the cluster is Enrolled in. Format: "projects/{project}/locations/{location}"
Description: Enrolls an existing VMware user cluster and its node pools to the Anthos On-Prem API within a given project and location. Through enrollment, an existing cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster and/or its node pools will be expected to be performed through the API.
▼ ▲ gkeonprem.projects.locations.vmwareClusters.queryVersionConfig
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Queries the VMware user cluster version config.
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters:queryVersionConfig
Parameters:
upgradeConfig.clusterName
Location: query
Type: string
Description: The user cluster resource name. This is the full resource name of the user cluster resource. Format: "projects/{project}/locations/{location}/vmwareClusters/{vmware_cluster}"
createConfig.adminClusterMembership
Location: query
Description: The admin cluster membership. This is the full resource name of the admin cluster's fleet membership. Format: "projects/{project}/locations/{location}/memberships/{membership}"
Type: string
createConfig.adminClusterName
Location: query
Type: string
Description: The admin cluster resource name. This is the full resource name of the admin cluster resource. Format: "projects/{project}/locations/{location}/vmwareAdminClusters/{vmware_admin_cluster}"
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Required: Yes
Location: path
Description: Required. The parent of the project and location to query for version config. Format: "projects/{project}/locations/{location}"
Path: v1/{+parent}/vmwareClusters:queryVersionConfig
▼ ▲ gkeonprem.projects.locations.vmwareClusters.unenroll
HTTP Method: DELETE
Path: v1/{+name}:unenroll
Description: Unenrolls an existing VMware user cluster and its node pools from the Anthos On-Prem API within a given project and location. Unenrollment removes the Cloud reference to the cluster without modifying the underlying OnPrem Resources. Clusters and node pools will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or UI.
Parameters:
name
Required: Yes
Description: Required. Name of the VMware user cluster to be unenrolled. Format: "projects/{project}/locations/{location}/vmwareClusters/{vmware_cluster}"
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+$
Location: path
Type: string
validateOnly
Type: boolean
Description: Validate the request without actually doing any updates.
Location: query
allowMissing
Location: query
Description: If set to true, and the VMware cluster is not found, the request will succeed but no action will be taken on the server and return a completed LRO.
Type: boolean
etag
Location: query
Type: string
Description: The current etag of the VMware Cluster. If an etag is provided and does not match the current etag of the cluster, deletion will be blocked and an ABORTED error will be returned.
force
Location: query
Type: boolean
Description: This is required if the cluster has any associated node pools. When set, any child node pools will also be unenrolled.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}:unenroll
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
▼ ▲ gkeonprem.projects.locations.operations.get
Path: v1/{+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.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Parameters:
name
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Description: The name of the operation resource.
Location: path
HTTP Method: GET
▼ ▲ gkeonprem.projects.locations.operations.list
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}/operations
Parameter Order: name
Parameters:
pageSize
Type: integer
Description: The standard list page size.
Location: query
Format: int32
pageToken
Description: The standard list page token.
Type: string
Location: query
name
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Type: string
Description: The name of the operation's parent resource.
Location: path
filter
Description: The standard list filter.
Location: query
Type: string
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ gkeonprem.projects.locations.operations.delete
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
name
Required: Yes
Description: The name of the operation resource to be deleted.
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
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`.
Path: v1/{+name}
HTTP Method: DELETE
▼ ▲ gkeonprem.projects.locations.operations.cancel
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}:cancel
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
Parameter Order: name
HTTP Method: POST
Parameters:
name
Type: string
Description: The name of the operation resource to be cancelled.
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location: path
Required: Yes
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`.
▼ ▲ gkeonprem.projects.locations.bareMetalClusters.enroll
HTTP Method: POST
Description: Enrolls an existing bare metal user cluster and its node pools to the Anthos On-Prem API within a given project and location. Through enrollment, an existing cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster and/or its node pools will be expected to be performed through the API.
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
Description: Required. The parent of the project and location where the cluster is enrolled in. Format: "projects/{project}/locations/{location}"
Type: string
Parameter Order: parent
Path: v1/{+parent}/bareMetalClusters:enroll
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters:enroll
▼ ▲ gkeonprem.projects.locations.bareMetalClusters.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Description: Deletes a single bare metal Cluster.
Parameters:
etag
Location: query
Description: The current etag of the bare metal Cluster. If an etag is provided and does not match the current etag of the cluster, deletion will be blocked and an ABORTED error will be returned.
Type: string
force
Type: boolean
Location: query
Description: If set to true, any node pools from the cluster will also be deleted.
ignoreErrors
Type: boolean
Description: If set to true, the deletion of a bare metal user cluster resource will succeed even if errors occur during deletion. This parameter can be used when you want to delete GCP's cluster resource and the on-prem admin cluster that hosts your user cluster is disconnected / unreachable or deleted. WARNING: Using this parameter when your user cluster still exists may result in a deleted GCP user cluster but an existing on-prem user cluster.
Location: query
validateOnly
Type: boolean
Location: query
Description: Validate the request without actually doing any updates.
allowMissing
Location: query
Description: If set to true, and the bare metal cluster is not found, the request will succeed but no action will be taken on the server and return a completed LRO.
Type: boolean
name
Pattern: ^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+$
Location: path
Required: Yes
Type: string
Description: Required. Name of the bare metal user cluster to be deleted. Format: "projects/{project}/locations/{location}/bareMetalClusters/{bare_metal_cluster}"
Parameter Order: name
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}
▼ ▲ gkeonprem.projects.locations.bareMetalClusters.getIamPolicy
Path: v1/{+resource}:getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameter Order: resource
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}:getIamPolicy
Parameters:
resource
Type: string
Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+$
options.requestedPolicyVersion
Format: int32
Location: query
Type: integer
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
HTTP Method: GET
▼ ▲ gkeonprem.projects.locations.bareMetalClusters.get
HTTP Method: GET
Description: Gets details of a single bare metal Cluster.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}
Parameter Order: name
Path: v1/{+name}
Parameters:
name
Description: Required. Name of the bare metal user cluster to get. Format: "projects/{project}/locations/{location}/bareMetalClusters/{bare_metal_cluster}"
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+$
▼ ▲ gkeonprem.projects.locations.bareMetalClusters.patch
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Location: path
Description: Immutable. The bare metal user cluster resource name.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+$
Required: Yes
allowMissing
Location: query
Type: boolean
Description: If set to true, and the bare metal cluster is not found, the request will create a new bare metal cluster with the provided configuration. The user must have both create and update permission to call Update with allow_missing set to true.
validateOnly
Description: Validate the request without actually doing any updates.
Location: query
Type: boolean
updateMask
Type: string
Description: Required. Field mask is used to specify the fields to be overwritten in the BareMetalCluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all populated fields in the BareMetalCluster message will be updated. Empty fields will be ignored unless a field mask is used.
Format: google-fieldmask
Location: query
Path: v1/{+name}
HTTP Method: PATCH
Parameter Order: name
Description: Updates the parameters of a single bare metal Cluster.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}
▼ ▲ gkeonprem.projects.locations.bareMetalClusters.unenroll
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Description: Unenrolls an existing bare metal user cluster and its node pools from the Anthos On-Prem API within a given project and location. Unenrollment removes the Cloud reference to the cluster without modifying the underlying OnPrem Resources. Clusters and node pools will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or its clients.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}:unenroll
Path: v1/{+name}:unenroll
Parameters:
force
Type: boolean
Description: This is required if the cluster has any associated node pools. When set, any child node pools will also be unenrolled.
Location: query
validateOnly
Location: query
Type: boolean
Description: Validate the request without actually doing any updates.
allowMissing
Description: If set to true, and the bare metal cluster is not found, the request will succeed but no action will be taken on the server and return a completed LRO.
Location: query
Type: boolean
etag
Location: query
Type: string
Description: The current etag of the bare metal Cluster. If an etag is provided and does not match the current etag of the cluster, deletion will be blocked and an ABORTED error will be returned.
name
Description: Required. Name of the bare metal user cluster to be unenrolled. Format: "projects/{project}/locations/{location}/bareMetalClusters/{cluster}"
Pattern: ^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+$
Required: Yes
Location: path
Type: string
▼ ▲ gkeonprem.projects.locations.bareMetalClusters.testIamPermissions
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}:testIamPermissions
Parameter Order: resource
Path: v1/{+resource}:testIamPermissions
HTTP Method: POST
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+$
Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required: Yes
Location: path
Type: string
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
▼ ▲ gkeonprem.projects.locations.bareMetalClusters.queryVersionConfig
HTTP Method: POST
Parameters:
createConfig.adminClusterName
Location: query
Description: The admin cluster resource name. This is the full resource name of the admin cluster resource. Format: "projects/{project}/locations/{location}/bareMetalAdminClusters/{bare_metal_admin_cluster}"
Type: string
parent
Required: Yes
Type: string
Description: Required. The parent of the project and location to query for version config. Format: "projects/{project}/locations/{location}"
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
upgradeConfig.clusterName
Description: The user cluster resource name. This is the full resource name of the user cluster resource. Format: "projects/{project}/locations/{location}/bareMetalClusters/{bare_metal_cluster}"
Type: string
Location: query
createConfig.adminClusterMembership
Type: string
Description: The admin cluster membership. This is the full resource name of the admin cluster's fleet membership. Format: "projects/{project}/locations/{location}/memberships/{membership}"
Location: query
Path: v1/{+parent}/bareMetalClusters:queryVersionConfig
Description: Queries the bare metal user cluster version config.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters:queryVersionConfig
Parameter Order: parent
▼ ▲ gkeonprem.projects.locations.bareMetalClusters.setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Location: path
Type: string
Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+$
Required: Yes
HTTP Method: POST
Parameter Order: resource
Path: v1/{+resource}:setIamPolicy
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}:setIamPolicy
▼ ▲ gkeonprem.projects.locations.bareMetalClusters.list
Description: Lists bare metal clusters in a given project and location.
Parameters:
parent
Description: Required. The parent of the project and location where the clusters are listed in. Format: "projects/{project}/locations/{location}"
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
filter
Location: query
Type: string
Description: A resource filtering expression following https://google.aip.dev/160. When non-empty, only resource's whose attributes field matches the filter are returned.
pageSize
Type: integer
Description: Requested page size. Server may return fewer items than requested. If unspecified, at most 50 clusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location: query
Format: int32
view
Enum:
Description: View for bare metal Clusters. When `BASIC` is specified, only the cluster resource name and admin cluster membership are returned. The default/unset value `CLUSTER_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete cluster configuration details.
Enum Descriptions:
Type: string
Location: query
pageToken
Description: A token identifying a page of results the server should return.
Location: query
Type: string
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters
HTTP Method: GET
Path: v1/{+parent}/bareMetalClusters
▼ ▲ gkeonprem.projects.locations.bareMetalClusters.create
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Parameters:
parent
Required: Yes
Type: string
Description: Required. The parent of the project and location where the cluster is created in. Format: "projects/{project}/locations/{location}"
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
bareMetalClusterId
Description: Required. User provided identifier that is used as part of the resource name; must conform to RFC-1034 and additionally restrict to lower-cased letters. This comes out roughly to: /^a-z+[a-z0-9]$/
Location: query
Type: string
validateOnly
Location: query
Description: Validate the request without actually doing any updates.
Type: boolean
Description: Creates a new bare metal cluster in a given project and location.
Path: v1/{+parent}/bareMetalClusters
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters
▼ ▲ gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.operations.list
HTTP Method: GET
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+/bareMetalNodePools/[^/]+$
Required: Yes
Description: The name of the operation's parent resource.
Location: path
Type: string
filter
Location: query
Description: The standard list filter.
Type: string
pageSize
Type: integer
Location: query
Description: The standard list page size.
Format: int32
pageToken
Description: The standard list page token.
Type: string
Location: query
Path: v1/{+name}/operations
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools/{bareMetalNodePoolsId}/operations
Parameter Order: name
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.operations.get
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+/bareMetalNodePools/[^/]+/operations/[^/]+$
Type: string
Description: The name of the operation resource.
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools/{bareMetalNodePoolsId}/operations/{operationsId}
HTTP Method: GET
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.
▼ ▲ gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.enroll
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools:enroll
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Path: v1/{+parent}/bareMetalNodePools:enroll
HTTP Method: POST
Parameters:
parent
Location: path
Description: Required. The parent resource where this node pool will be created. projects/{project}/locations/{location}/bareMetalClusters/{cluster}
Pattern: ^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+$
Required: Yes
Type: string
Description: Enrolls an existing bare metal node pool to the Anthos On-Prem API within a given project and location. Through enrollment, an existing node pool will become Anthos On-Prem API managed. The corresponding GCP resources will be created.
▼ ▲ gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.patch
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools/{bareMetalNodePoolsId}
HTTP Method: PATCH
Parameters:
name
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+/bareMetalNodePools/[^/]+$
Required: Yes
Description: Immutable. The bare metal node pool resource name.
updateMask
Description: Required. Field mask is used to specify the fields to be overwritten in the BareMetalNodePool resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all populated fields in the BareMetalNodePool message will be updated. Empty fields will be ignored unless a field mask is used.
Type: string
Format: google-fieldmask
Location: query
validateOnly
Location: query
Description: Validate the request without actually doing any updates.
Type: boolean
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Description: Updates the parameters of a single bare metal node pool.
Path: v1/{+name}
▼ ▲ gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.create
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+$
Required: Yes
Type: string
Location: path
Description: Required. The parent resource where this node pool will be created. projects/{project}/locations/{location}/bareMetalClusters/{cluster}
bareMetalNodePoolId
Description: The ID to use for the node pool, which will become the final component of the node pool's resource name. This value must be up to 63 characters, and valid characters are /a-z-/. The value must not be permitted to be a UUID (or UUID-like: anything matching /^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$/i).
Type: string
Location: query
validateOnly
Location: query
Type: boolean
Description: If set, only validate the request, but do not actually create the node pool.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools
Description: Creates a new bare metal node pool in a given project, location and Bare Metal cluster.
Parameter Order: parent
Path: v1/{+parent}/bareMetalNodePools
▼ ▲ gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.delete
HTTP Method: DELETE
Path: v1/{+name}
Description: Deletes a single bare metal node pool.
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools/{bareMetalNodePoolsId}
Parameters:
validateOnly
Location: query
Type: boolean
Description: If set, only validate the request, but do not actually delete the node pool.
etag
Description: The current etag of the BareMetalNodePool. If an etag is provided and does not match the current etag of the node pool, deletion will be blocked and an ABORTED error will be returned.
Location: query
Type: string
ignoreErrors
Location: query
Description: If set to true, the deletion of a bare metal node pool resource will succeed even if errors occur during deletion. This parameter can be used when you want to delete GCP's node pool resource and you've already deleted the on-prem admin cluster that hosted your node pool. WARNING: Using this parameter when your user cluster still exists may result in a deleted GCP node pool but an existing on-prem node pool.
Type: boolean
name
Description: Required. The name of the node pool to delete. Format: projects/{project}/locations/{location}/bareMetalClusters/{cluster}/bareMetalNodePools/{nodepool}
Pattern: ^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+/bareMetalNodePools/[^/]+$
Location: path
Required: Yes
Type: string
allowMissing
Location: query
Type: boolean
Description: If set to true, and the bare metal node pool is not found, the request will succeed but no action will be taken on the server and return a completed LRO.
▼ ▲ gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.setIamPolicy
Path: v1/{+resource}:setIamPolicy
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+/bareMetalNodePools/[^/]+$
Type: string
Required: Yes
Location: path
Parameter Order: resource
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools/{bareMetalNodePoolsId}:setIamPolicy
▼ ▲ gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.testIamPermissions
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools/{bareMetalNodePoolsId}:testIamPermissions
HTTP Method: POST
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+/bareMetalNodePools/[^/]+$
Required: Yes
Location: path
Type: string
Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Parameter Order: resource
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+resource}:testIamPermissions
▼ ▲ gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.getIamPolicy
Parameters:
resource
Type: string
Required: Yes
Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+/bareMetalNodePools/[^/]+$
Location: path
options.requestedPolicyVersion
Type: integer
Format: int32
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Location: query
Parameter Order: resource
HTTP Method: GET
Path: v1/{+resource}:getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools/{bareMetalNodePoolsId}:getIamPolicy
▼ ▲ gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.unenroll
Description: Unenrolls a bare metal node pool from Anthos On-Prem API.
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools/{bareMetalNodePoolsId}:unenroll
Parameters:
allowMissing
Location: query
Type: boolean
Description: If set to true, and the bare metal node pool is not found, the request will succeed but no action will be taken on the server and return a completed LRO.
validateOnly
Location: query
Type: boolean
Description: If set, only validate the request, but do not actually unenroll the node pool.
etag
Description: The current etag of the bare metal node pool. If an etag is provided and does not match the current etag of node pool, deletion will be blocked and an ABORTED error will be returned.
Location: query
Type: string
name
Required: Yes
Location: path
Type: string
Description: Required. The name of the node pool to unenroll. Format: projects/{project}/locations/{location}/bareMetalClusters/{cluster}/bareMetalNodePools/{nodepool}
Pattern: ^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+/bareMetalNodePools/[^/]+$
Path: v1/{+name}:unenroll
HTTP Method: DELETE
▼ ▲ gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.get
Path: v1/{+name}
HTTP Method: GET
Description: Gets details of a single bare metal node pool.
Parameters:
name
Location: path
Description: Required. The name of the node pool to retrieve. projects/{project}/locations/{location}/bareMetalClusters/{cluster}/bareMetalNodePools/{nodepool}
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+/bareMetalNodePools/[^/]+$
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools/{bareMetalNodePoolsId}
Parameter Order: name
▼ ▲ gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.list
Parameters:
parent
Required: Yes
Description: Required. The parent, which owns this collection of node pools. Format: projects/{project}/locations/{location}/bareMetalClusters/{bareMetalCluster}
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+$
pageSize
Description: The maximum number of node pools to return. The service may return fewer than this value. If unspecified, at most 50 node pools will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Type: integer
Location: query
Format: int32
pageToken
Type: string
Description: A page token, received from a previous `ListBareMetalNodePools` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBareMetalNodePools` must match the call that provided the page token.
Location: query
Description: Lists bare metal node pools in a given project, location and bare metal cluster.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Path: v1/{+parent}/bareMetalNodePools
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools
Parameter Order: parent
▼ ▲ gkeonprem.projects.locations.bareMetalClusters.operations.list
Path: v1/{+name}/operations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/operations
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
pageToken
Location: query
Description: The standard list page token.
Type: string
pageSize
Type: integer
Description: The standard list page size.
Format: int32
Location: query
filter
Type: string
Description: The standard list filter.
Location: query
name
Type: string
Location: path
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+$
Required: Yes
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
HTTP Method: GET
▼ ▲ gkeonprem.projects.locations.bareMetalClusters.operations.get
HTTP Method: GET
Parameters:
name
Location: path
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+/operations/[^/]+$
Required: Yes
Type: string
Path: v1/{+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.
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/operations/{operationsId}
▼ ▲ gkeonprem.projects.locations.bareMetalAdminClusters.operations.get
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/bareMetalAdminClusters/[^/]+/operations/[^/]+$
Description: The name of the operation resource.
Type: string
Required: Yes
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters/{bareMetalAdminClustersId}/operations/{operationsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
HTTP Method: GET
Path: v1/{+name}
▼ ▲ gkeonprem.projects.locations.bareMetalAdminClusters.operations.list
Path: v1/{+name}/operations
Parameter Order: name
HTTP Method: GET
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Parameters:
filter
Type: string
Location: query
Description: The standard list filter.
pageSize
Location: query
Format: int32
Type: integer
Description: The standard list page size.
pageToken
Description: The standard list page token.
Location: query
Type: string
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/bareMetalAdminClusters/[^/]+$
Location: path
Description: The name of the operation's parent resource.
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters/{bareMetalAdminClustersId}/operations
▼ ▲ gkeonprem.projects.locations.bareMetalAdminClusters.testIamPermissions
Path: v1/{+resource}:testIamPermissions
HTTP Method: POST
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/bareMetalAdminClusters/[^/]+$
Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required: Yes
Type: string
Location: path
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters/{bareMetalAdminClustersId}:testIamPermissions
▼ ▲ gkeonprem.projects.locations.bareMetalAdminClusters.enroll
HTTP Method: POST
Path: v1/{+parent}/bareMetalAdminClusters:enroll
Parameters:
parent
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Description: Required. The parent of the project and location where the cluster is enrolled in. Format: "projects/{project}/locations/{location}"
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters:enroll
Description: Enrolls an existing bare metal admin cluster to the Anthos On-Prem API within a given project and location. Through enrollment, an existing admin cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster will be expected to be performed through the API.
▼ ▲ gkeonprem.projects.locations.bareMetalAdminClusters.getIamPolicy
HTTP Method: GET
Parameter Order: resource
Path: v1/{+resource}:getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
options.requestedPolicyVersion
Type: integer
Format: int32
Location: query
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
resource
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/bareMetalAdminClusters/[^/]+$
Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters/{bareMetalAdminClustersId}:getIamPolicy
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
▼ ▲ gkeonprem.projects.locations.bareMetalAdminClusters.patch
HTTP Method: PATCH
Path: v1/{+name}
Parameters:
updateMask
Description: Required. Field mask is used to specify the fields to be overwritten in the BareMetalAdminCluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all populated fields in the BareMetalAdminCluster message will be updated. Empty fields will be ignored unless a field mask is used.
Location: query
Format: google-fieldmask
Type: string
name
Type: string
Description: Immutable. The bare metal admin cluster resource name.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/bareMetalAdminClusters/[^/]+$
Required: Yes
validateOnly
Type: boolean
Description: Validate the request without actually doing any updates.
Location: query
Parameter Order: name
Description: Updates the parameters of a single bare metal admin cluster.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters/{bareMetalAdminClustersId}
▼ ▲ gkeonprem.projects.locations.bareMetalAdminClusters.queryVersionConfig
Path: v1/{+parent}/bareMetalAdminClusters:queryVersionConfig
Parameters:
upgradeConfig.clusterName
Location: query
Description: The admin cluster resource name. This is the full resource name of the admin cluster resource. Format: "projects/{project}/locations/{location}/bareMetalAdminClusters/{bare_metal_admin_cluster}"
Type: string
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Description: Required. The parent of the project and location to query for version config. Format: "projects/{project}/locations/{location}"
Type: string
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters:queryVersionConfig
Description: Queries the bare metal admin cluster version config.
HTTP Method: POST
Parameter Order: parent
▼ ▲ gkeonprem.projects.locations.bareMetalAdminClusters.unenroll
Description: Unenrolls an existing bare metal admin cluster from the Anthos On-Prem API within a given project and location. Unenrollment removes the Cloud reference to the cluster without modifying the underlying OnPrem Resources. Clusters will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or its clients.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters/{bareMetalAdminClustersId}:unenroll
HTTP Method: DELETE
Path: v1/{+name}:unenroll
Parameters:
allowMissing
Type: boolean
Description: If set to true, and the bare metal admin cluster is not found, the request will succeed but no action will be taken on the server and return a completed LRO.
Location: query
validateOnly
Location: query
Description: Validate the request without actually doing any updates.
Type: boolean
etag
Location: query
Type: string
Description: The current etag of the bare metal admin cluster. If an etag is provided and does not match the current etag of the cluster, deletion will be blocked and an ABORTED error will be returned.
name
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/bareMetalAdminClusters/[^/]+$
Description: Required. Name of the bare metal admin cluster to be unenrolled. Format: "projects/{project}/locations/{location}/bareMetalAdminClusters/{cluster}"
▼ ▲ gkeonprem.projects.locations.bareMetalAdminClusters.get
Parameter Order: name
Path: v1/{+name}
Description: Gets details of a single bare metal admin cluster.
Parameters:
name
Location: path
Type: string
Description: Required. Name of the bare metal admin cluster to get. Format: "projects/{project}/locations/{location}/bareMetalAdminClusters/{bare_metal_admin_cluster}"
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/bareMetalAdminClusters/[^/]+$
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters/{bareMetalAdminClustersId}
HTTP Method: GET
▼ ▲ gkeonprem.projects.locations.bareMetalAdminClusters.list
Parameters:
pageSize
Format: int32
Location: query
Type: integer
Description: Requested page size. Server may return fewer items than requested. If unspecified, at most 50 clusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
parent
Type: string
Required: Yes
Description: Required. The parent of the project and location where the clusters are listed in. Format: "projects/{project}/locations/{location}"
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
view
Type: string
Description: View for bare metal admin clusters. When `BASIC` is specified, only the admin cluster resource name and membership are returned. The default/unset value `CLUSTER_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete admin cluster configuration details.
Enum:
Enum Descriptions:
Location: query
pageToken
Location: query
Description: A token identifying a page of results the server should return.
Type: string
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Description: Lists bare metal admin clusters in a given project and location.
Path: v1/{+parent}/bareMetalAdminClusters
▼ ▲ gkeonprem.projects.locations.bareMetalAdminClusters.setIamPolicy
Path: v1/{+resource}:setIamPolicy
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/bareMetalAdminClusters/[^/]+$
Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Type: string
Required: Yes
Location: path
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters/{bareMetalAdminClustersId}:setIamPolicy
HTTP Method: POST
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: resource
▼ ▲ gkeonprem.projects.locations.bareMetalAdminClusters.create
Parameter Order: parent
Description: Creates a new bare metal admin cluster in a given project and location. The API needs to be combined with creating a bootstrap cluster to work. See: https://cloud.google.com/anthos/clusters/docs/bare-metal/latest/installing/creating-clusters/create-admin-cluster-api#prepare_bootstrap_environment
Path: v1/{+parent}/bareMetalAdminClusters
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters
HTTP Method: POST
Parameters:
validateOnly
Description: Validate the request without actually doing any updates.
Type: boolean
Location: query
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Description: Required. The parent of the project and location where the cluster is created in. Format: "projects/{project}/locations/{location}"
Location: path
Required: Yes
bareMetalAdminClusterId
Type: string
Description: Required. User provided identifier that is used as part of the resource name; must conform to RFC-1034 and additionally restrict to lower-cased letters. This comes out roughly to: /^a-z+[a-z0-9]$/
Location: query
▼ ▲ gkeonprem.projects.locations.vmwareAdminClusters.operations.list
Path: v1/{+name}/operations
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters/{vmwareAdminClustersId}/operations
Parameters:
name
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareAdminClusters/[^/]+$
Type: string
Description: The name of the operation's parent resource.
pageSize
Location: query
Type: integer
Format: int32
Description: The standard list page size.
pageToken
Location: query
Description: The standard list page token.
Type: string
filter
Description: The standard list filter.
Location: query
Type: string
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
HTTP Method: GET
Parameter Order: name
▼ ▲ gkeonprem.projects.locations.vmwareAdminClusters.operations.get
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Parameter Order: name
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareAdminClusters/[^/]+/operations/[^/]+$
Required: Yes
Description: The name of the operation resource.
Type: string
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.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters/{vmwareAdminClustersId}/operations/{operationsId}
▼ ▲ gkeonprem.projects.locations.vmwareAdminClusters.get
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Location: path
Description: Required. Name of the VMware admin cluster to be returned. Format: "projects/{project}/locations/{location}/vmwareAdminClusters/{vmware_admin_cluster}"
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareAdminClusters/[^/]+$
Required: Yes
Path: v1/{+name}
Description: Gets details of a single VMware admin cluster.
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters/{vmwareAdminClustersId}
▼ ▲ gkeonprem.projects.locations.vmwareAdminClusters.list
Parameter Order: parent
Description: Lists VMware admin clusters in a given project and location.
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters
Parameters:
pageToken
Type: string
Description: A token identifying a page of results the server should return.
Location: query
pageSize
Description: Requested page size. Server may return fewer items than requested. If unspecified, at most 50 clusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Format: int32
Location: query
Type: integer
parent
Required: Yes
Location: path
Description: Required. The parent of the project and location where the clusters are listed in. Format: "projects/{project}/locations/{location}"
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
view
Description: View for VMware admin clusters. When `BASIC` is specified, only the admin cluster resource name and membership are returned. The default/unset value `CLUSTER_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete admin cluster configuration details.
Enum Descriptions:
Type: string
Location: query
Enum:
Path: v1/{+parent}/vmwareAdminClusters
▼ ▲ gkeonprem.projects.locations.vmwareAdminClusters.patch
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters/{vmwareAdminClustersId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Description: Updates the parameters of a single VMware admin cluster.
Path: v1/{+name}
HTTP Method: PATCH
Parameters:
updateMask
Format: google-fieldmask
Type: string
Location: query
Description: Required. Field mask is used to specify the fields to be overwritten in the VMwareAdminCluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all populated fields in the VmwareAdminCluster message will be updated. Empty fields will be ignored unless a field mask is used.
validateOnly
Description: Validate the request without actually doing any updates.
Type: boolean
Location: query
name
Description: Immutable. The VMware admin cluster resource name.
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareAdminClusters/[^/]+$
▼ ▲ gkeonprem.projects.locations.vmwareAdminClusters.testIamPermissions
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters:
resource
Location: path
Required: Yes
Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareAdminClusters/[^/]+$
Type: string
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters/{vmwareAdminClustersId}:testIamPermissions
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+resource}:testIamPermissions
HTTP Method: POST
▼ ▲ gkeonprem.projects.locations.vmwareAdminClusters.setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: resource
HTTP Method: POST
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters/{vmwareAdminClustersId}:setIamPolicy
Path: v1/{+resource}:setIamPolicy
Parameters:
resource
Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareAdminClusters/[^/]+$
Location: path
▼ ▲ gkeonprem.projects.locations.vmwareAdminClusters.enroll
Description: Enrolls an existing VMware admin cluster to the Anthos On-Prem API within a given project and location. Through enrollment, an existing admin cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster will be expected to be performed through the API.
Parameters:
parent
Type: string
Description: Required. The parent of the project and location where the cluster is enrolled in. Format: "projects/{project}/locations/{location}"
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Path: v1/{+parent}/vmwareAdminClusters:enroll
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters:enroll
HTTP Method: POST
▼ ▲ gkeonprem.projects.locations.vmwareAdminClusters.unenroll
HTTP Method: DELETE
Description: Unenrolls an existing VMware admin cluster from the Anthos On-Prem API within a given project and location. Unenrollment removes the Cloud reference to the cluster without modifying the underlying OnPrem Resources. Clusters will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or its clients.
Parameters:
etag
Description: The current etag of the VMware admin cluster. If an etag is provided and does not match the current etag of the cluster, deletion will be blocked and an ABORTED error will be returned.
Type: string
Location: query
name
Required: Yes
Type: string
Description: Required. Name of the VMware admin cluster to be unenrolled. Format: "projects/{project}/locations/{location}/vmwareAdminClusters/{cluster}"
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareAdminClusters/[^/]+$
allowMissing
Location: query
Type: boolean
Description: If set to true, and the VMware admin cluster is not found, the request will succeed but no action will be taken on the server and return a completed LRO.
validateOnly
Type: boolean
Location: query
Description: Validate the request without actually doing any updates.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters/{vmwareAdminClustersId}:unenroll
Path: v1/{+name}:unenroll
▼ ▲ gkeonprem.projects.locations.vmwareAdminClusters.getIamPolicy
Parameters:
resource
Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareAdminClusters/[^/]+$
Type: string
Required: Yes
Location: path
options.requestedPolicyVersion
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Location: query
Format: int32
Type: integer
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters/{vmwareAdminClustersId}:getIamPolicy
Parameter Order: resource
HTTP Method: GET
Path: v1/{+resource}:getIamPolicy