Method: environments.list

Full name: projects.locations.instances.environments.list

Lists Environments.

HTTP request


Path parameters

Parameters
parent

string

Required. The instance to list Environments for. Format: projects/{project}/locations/{location}/instances/{instance}/environments

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of Environments to return. The service may return fewer than this value. If unspecified, at most 50 Environments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

Optional. A page token, received from a previous environments.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBooks must match the call that provided the page token.
filter

string

Optional. A filter to apply to the list of Environments. Supported filter fields: * displayName * default * system * weight * retentionDuration * aliases * dynamicParameters * contact_title * contactEmails * contactPhone * description * weight * retentionDuration Example: filter="displayName='some_name'"
orderBy

string

Optional. Configures ordering of Environments in the response. If not specified, Environments are returned in descending order of their create time. The default ordering is by create time in descending order. The orderBy string is a comma separated list of fields. Supported sort fields: * displayName * default * system * weight * retentionDuration * aliases * contact_title * contactEmails * contactPhone * description * weight * retentionDuration example: "displayName desc, system"

Request body

The request body must be empty.

Response body

Response message for environments.list.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "environments": [
    {
      object (Environment)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Fields
environments[]

object (Environment)

The list of Environments.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
totalSize

integer

Total number of Environments includes filter without pagination.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.