Method: projects.locations.memberships.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists Memberships in a given project and location.
HTTP request
GET https://gkehub.googleapis.com/v1beta/{parent=projects/*/locations/*}/memberships
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
parent |
string
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.
Authorization requires the following IAM permission on the specified resource parent :
|
Query parameters
Parameters |
pageSize |
integer
Optional. When requesting a 'page' of resources, pageSize specifies number of resources to return. If unspecified or set to 0, all resources will be returned.
|
pageToken |
string
Optional. Token returned by previous call to memberships.list which specifies the position in the list from where to continue listing the resources.
|
filter |
string
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
|
orderBy |
string
Optional. One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.
|
Request body
The request body must be empty.
Response body
Response message for the GkeHub.ListMemberships
method.
If successful, the response body contains data with the following structure:
JSON representation |
{
"resources": [
{
object (Membership )
}
],
"nextPageToken": string,
"unreachable": [
string
]
} |
Fields |
resources[] |
object (Membership )
The list of matching Memberships.
|
nextPageToken |
string
A token to request the next page of resources from the memberships.list method. The value of an empty string means that there are no more resources to return.
|
unreachable[] |
string
List of locations that could not be reached while fetching this list.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-12 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-12 UTC."],[],[],null,["# Method: projects.locations.memberships.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListMembershipsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Examples](#examples)\n- [Try it!](#try-it)\n\nLists Memberships in a given project and location.\n\n### HTTP request\n\n`GET https://gkehub.googleapis.com/v1beta/{parent=projects/*/locations/*}/memberships`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for the `GkeHub.ListMemberships` method.\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]