Required. The resource name of the lake location, of the form:projects/{project_number}/locations/{locationId}wherelocationIdrefers to a Google Cloud region.
Authorization requires the followingIAMpermission on the specified resourceparent:
dataplex.lakes.list
Query parameters
Parameters
pageSize
integer
Optional. Maximum number of Lakes to return. The service may return fewer than this value. If unspecified, at most 10 lakes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken
string
Optional. Page token received from a previouslakes.listcall. Provide this to retrieve the subsequent page. When paginating, all other parameters provided tolakes.listmust match the call that provided the page token.
filter
string
Optional. Filter request.
orderBy
string
Optional. Order by fields for the result.
Request body
The request body must be empty.
Response body
List lakes response.
If successful, the response body contains data with the following structure:
[[["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-07-21 UTC."],[[["\u003cp\u003eThis endpoint lists lake resources within a specified project and location using a \u003ccode\u003eGET\u003c/code\u003e request.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a \u003ccode\u003eparent\u003c/code\u003e path parameter indicating the project and location, and accepts optional query parameters such as \u003ccode\u003epageSize\u003c/code\u003e, \u003ccode\u003epageToken\u003c/code\u003e, \u003ccode\u003efilter\u003c/code\u003e, and \u003ccode\u003eorderBy\u003c/code\u003e for controlling the returned results.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003elakes.list\u003c/code\u003e call will return a response with an array of lake objects, a \u003ccode\u003enextPageToken\u003c/code\u003e to paginate the results, and a list of \u003ccode\u003eunreachableLocations\u003c/code\u003e if any exist.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should be empty, and the required authorization scope is \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.lakes.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.ListLakesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists lake resources in a project and location.\n\n### HTTP request\n\n`GET https://dataplex.googleapis.com/v1/{parent=projects/*/locations/*}/lakes`\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\nList lakes response.\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)."]]
