Version 5.0

Method: projects.locations.groups.list

Lists Groups in a given project and location.

HTTP request

GET https://vmmigration.googleapis.com/v1alpha1/{parent=projects/*/locations/*}/groups

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of groups.

Query parameters

Parameters
pageSize

integer

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

pageToken

string

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

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

filter

string

Optional. The filter request.

orderBy

string

Optional. the order by fields for the result.

Request body

The request body must be empty.

Response body

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

Response message for 'groups.list' request.

JSON representation
{
  "groups": [
    {
      object (Group)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Fields
groups[]

object (Group)

Output only. The list of groups response.

nextPageToken

string

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

unreachable[]

string

Output only. Locations that could not be reached.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.