2024-03-13
▼ ▲ gkehub.projects.locations.list
Path: v1alpha2/{+name}/locations
Flat Path: v1alpha2/projects/{projectsId}/locations
HTTP Method: GET
Parameters:
name
Description: The resource that owns the locations collection, if applicable.
Pattern: ^projects/[^/]+$
Location: path
Required: Yes
Type: string
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
Description: The maximum number of results to return. If not set, the service selects a default.
Location: query
Type: integer
Format: int32
pageToken
Description: A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists information about the supported locations for this service.
▼ ▲ gkehub.projects.locations.get
Path: v1alpha2/{+name}
Flat Path: v1alpha2/projects/{projectsId}/locations/{locationsId}
HTTP Method: GET
Parameters:
name
Description: Resource name for the location.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets information about a location.
▼ ▲ gkehub.projects.locations.operations.list
Path: v1alpha2/{+name}/operations
Flat Path: v1alpha2/projects/{projectsId}/locations/{locationsId}/operations
HTTP Method: GET
Parameters:
name
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
filter
Description: The standard list filter.
Location: query
Type: string
pageSize
Description: The standard list page size.
Location: query
Type: integer
Format: int32
pageToken
Description: The standard list page token.
Location: query
Type: string
Parameter Order: name
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`.
▼ ▲ gkehub.projects.locations.operations.get
Path: v1alpha2/{+name}
Flat Path: v1alpha2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method: GET
Parameters:
name
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
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.
▼ ▲ gkehub.projects.locations.operations.delete
Path: v1alpha2/{+name}
Flat Path: v1alpha2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method: DELETE
Parameters:
name
Description: The name of the operation resource to be deleted.
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
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`.
▼ ▲ gkehub.projects.locations.operations.cancel
Path: v1alpha2/{+name}:cancel
Flat Path: v1alpha2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
HTTP Method: POST
Parameters:
name
Description: The name of the operation resource to be cancelled.
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
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`.
▼ ▲ gkehub.projects.locations.memberships.list
Path: v1alpha2/{+parent}/memberships
Flat Path: v1alpha2/projects/{projectsId}/locations/{locationsId}/memberships
HTTP Method: GET
Parameters:
parent
Description: Required. The parent (project and location) where the Memberships will be listed. Specified in the format `projects/*/locations/*`. `projects/*/locations/-` list memberships in all the regions.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. Token returned by previous call to `ListMemberships` which specifies the position in the list from where to continue listing the resources.
Location: query
Type: string
filter
Description: Optional. Lists Memberships that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Examples: - Name is `bar` in project `foo-proj` and location `global`: name = "projects/foo-proj/locations/global/membership/bar" - Memberships that have a label called `foo`: labels.foo:* - Memberships that have a label called `foo` whose value is `bar`: labels.foo = bar - Memberships in the CREATING state: state = CREATING
Location: query
Type: string
orderBy
Description: Optional. One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists Memberships in a given project and location.
▼ ▲ gkehub.projects.locations.memberships.get
Path: v1alpha2/{+name}
Flat Path: v1alpha2/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}
HTTP Method: GET
Parameters:
name
Description: Required. The Membership resource name in the format `projects/*/locations/*/memberships/*`.
Pattern: ^projects/[^/]+/locations/[^/]+/memberships/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets the details of a Membership.
▼ ▲ gkehub.projects.locations.memberships.create
Path: v1alpha2/{+parent}/memberships
Flat Path: v1alpha2/projects/{projectsId}/locations/{locationsId}/memberships
HTTP Method: POST
Parameters:
parent
Description: Required. The parent (project and location) where the Memberships will be created. Specified in the format `projects/*/locations/*`.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
membershipId
Description: Required. Client chosen ID for the membership. `membership_id` must be a valid RFC 1123 compliant DNS label: 1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or `-` 3. It must start and end with an alphanumeric character Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`, with a maximum length of 63 characters.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a new Membership. **This is currently only supported for GKE clusters on Google Cloud**. To register other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.
▼ ▲ gkehub.projects.locations.memberships.delete
Path: v1alpha2/{+name}
Flat Path: v1alpha2/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The Membership resource name in the format `projects/*/locations/*/memberships/*`.
Pattern: ^projects/[^/]+/locations/[^/]+/memberships/[^/]+$
Location: path
Required: Yes
Type: string
force
Description: Optional. If set to true, any subresource from this Membership will also be deleted. Otherwise, the request will only work if the Membership has no subresource.
Location: query
Type: boolean
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Removes a Membership. **This is currently only supported for GKE clusters on Google Cloud**. To unregister other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.
▼ ▲ gkehub.projects.locations.memberships.patch
Path: v1alpha2/{+name}
Flat Path: v1alpha2/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}
HTTP Method: PATCH
Parameters:
name
Description: Required. The Membership resource name in the format `projects/*/locations/*/memberships/*`.
Pattern: ^projects/[^/]+/locations/[^/]+/memberships/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Required. Mask of fields to update.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates an existing Membership.
▼ ▲ gkehub.projects.locations.memberships.generateConnectManifest
Path: v1alpha2/{+name}:generateConnectManifest
Flat Path: v1alpha2/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}:generateConnectManifest
HTTP Method: GET
Parameters:
name
Description: Required. The Membership resource name the Agent will associate with, in the format `projects/*/locations/*/memberships/*`.
Pattern: ^projects/[^/]+/locations/[^/]+/memberships/[^/]+$
Location: path
Required: Yes
Type: string
namespace
Description: Optional. Namespace for GKE Connect agent resources. Defaults to `gke-connect`. The Connect Agent is authorized automatically when run in the default namespace. Otherwise, explicit authorization must be granted with an additional IAM binding.
Location: query
Type: string
proxy
Description: Optional. URI of a proxy if connectivity from the agent to gkeconnect.googleapis.com requires the use of a proxy. Format must be in the form `http(s)://{proxy_address}`, depending on the HTTP/HTTPS protocol supported by the proxy. This will direct the connect agent's outbound traffic through a HTTP(S) proxy.
Location: query
Type: string
Format: byte
version
Description: Optional. The Connect agent version to use. Defaults to the most current version.
Location: query
Type: string
isUpgrade
Description: Optional. If true, generate the resources for upgrade only. Some resources generated only for installation (e.g. secrets) will be excluded.
Location: query
Type: boolean
registry
Description: Optional. The registry to fetch the connect agent image from. Defaults to gcr.io/gkeconnect.
Location: query
Type: string
imagePullSecretContent
Description: Optional. The image pull secret content for the registry, if not public.
Location: query
Type: string
Format: byte
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Generates the manifest for deployment of the GKE connect agent. **This method is used internally by Google-provided libraries.** Most clients should not need to call this method directly.
▼ ▲ gkehub.projects.locations.memberships.setIamPolicy
Path: v1alpha2/{+resource}:setIamPolicy
Flat Path: v1alpha2/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}:setIamPolicy
HTTP Method: POST
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/[^/]+/memberships/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
▼ ▲ gkehub.projects.locations.memberships.getIamPolicy
Path: v1alpha2/{+resource}:getIamPolicy
Flat Path: v1alpha2/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}:getIamPolicy
HTTP Method: GET
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/[^/]+/memberships/[^/]+$
Location: path
Required: Yes
Type: string
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
Type: integer
Format: int32
Parameter Order: resource
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.
▼ ▲ gkehub.projects.locations.memberships.testIamPermissions
Path: v1alpha2/{+resource}:testIamPermissions
Flat Path: v1alpha2/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}:testIamPermissions
HTTP Method: POST
Parameters:
resource
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/[^/]+/memberships/[^/]+$
Location: path
Required: Yes
Type: string
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.
▼ ▲ gkehub.projects.locations.global.memberships.initializeHub
Path: v1alpha2/{+project}:initializeHub
Flat Path: v1alpha2/projects/{projectsId}/locations/global/memberships:initializeHub
HTTP Method: POST
Parameters:
project
Description: Required. The Hub to initialize, in the format `projects/*/locations/*/memberships/*`.
Pattern: ^projects/[^/]+/locations/global/memberships$
Location: path
Required: Yes
Type: string
Parameter Order: project
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Initializes the Hub in this project, which includes creating the default Hub Service Account and the Hub Workload Identity Pool. Initialization is optional, and happens automatically when the first Membership is created. InitializeHub should be called when the first Membership cannot be registered without these resources. A common example is granting the Hub Service Account access to another project, which requires the account to exist first.