Required. The resource name of the parent lake: projects/{projectId}/locations/{locationId}/lakes/{lakeId}.
Authorization requires the following IAM permission on the specified resource parent:
dataplex.environments.list
Query parameters
Parameters
pageSize
integer
Optional. Maximum number of environments to return. The service may return fewer than this value. If unspecified, at most 10 environments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken
string
Optional. Page token received from a previous environments.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to environments.list must 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 environments 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 environments within a specified lake using a GET request to the provided URL structure: \u003ccode\u003ehttps://dataplex.googleapis.com/v1/{parent=projects/*/locations/*/lakes/*}/environments\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a \u003ccode\u003eparent\u003c/code\u003e path parameter specifying the lake's resource name and supports 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 pagination and filtering.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must be empty and the response body, if successful, will contain a list of \u003ccode\u003eenvironments\u003c/code\u003e and a \u003ccode\u003enextPageToken\u003c/code\u003e for pagination.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization to use this endpoint necessitates the \u003ccode\u003edataplex.environments.list\u003c/code\u003e IAM permission on the parent resource, along with the OAuth scope \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe maximum number of environments that will be returned at once is 1000.\u003c/p\u003e\n"]]],[],null,[]]
