Method: environmentGroups.list

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

List EnvironmentGroups.

HTTP request


GET https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{parent}/environmentGroups

Path parameters

Parameters
parent

string

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

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of EnvironmentGroups to return. The service may return fewer than this value.
pageToken

string

Optional. A page token, received from a previous environmentGroups.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to environmentGroups.list must match the call that provided the page token.
filter

string

Optional. Filter to be applied over multiple EnvironmentGroup fields.
orderBy

string

Optional. The order in which items should be returned.

Request body

The request body must be empty.

Response body

Response message for environmentGroups.list.

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

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

object (EnvironmentGroup)

The list of EnvironmentGroups.
nextPageToken

string

Optional. 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

Optional. Total number of EnvironmentGroups in all pages.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • chronicle.environmentGroups.get

For more information, see the IAM documentation.