Method: projects.locations.workerPools.list

Lists WorkerPools. Results are sorted by creation time, descending.

HTTP request

GET https://run.googleapis.com/v2/{parent}/workerPools

Path parameters

Parameters
parent

string

Required. The location and project to list resources on. Location must be a valid Google Cloud region, and cannot be the "-" wildcard. Format: projects/{project}/locations/{location}, where {project} can be project id or number. It takes the form projects/{project}/locations/{location}.

Authorization requires the following IAM permission on the specified resource parent:

  • run.workerpools.list

Query parameters

Parameters
pageSize

integer

Maximum number of WorkerPools to return in this call.
pageToken

string

A page token received from a previous call to workerPools.list. All other parameters must match.
showDeleted

boolean

If true, returns deleted (but unexpired) resources along with active ones.

Request body

The request body must be empty.

Response body

Response message containing a list of WorkerPools.

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

JSON representation 
{
  "workerPools": [
    {
      object (WorkerPool)
    }
  ],
  "nextPageToken": string
}
Fields
workerPools[]

object (WorkerPool)

The resulting list of WorkerPools.
nextPageToken

string

A token indicating there are more items than pageSize. Use it in the next workerPools.list request to continue.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.