Method: namespaces.workerpools.list

Lists worker pools for the given project and region. Results are sorted by creation time, descending.

HTTP request

GET https://run.googleapis.com/apis/run.googleapis.com/v1/{parent}/workerpools

Path parameters

Parameters
parent

string

Required. The parent from where the resources should be listed. In Cloud Run, it may be one of the following:

  • {project_id_or_number}
  • namespaces/{project_id_or_number}
  • namespaces/{project_id_or_number}/workerpools
  • projects/{project_id_or_number}/locations/{region}
  • projects/{project_id_or_number}/regions/{region} It takes the form namespaces/{namespace}.

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

  • run.workerpools.list

Query parameters

Parameters
limit

integer

The maximum number of records that should be returned.

labelSelector

string

=, !=, exists, in, and notIn.

continue

string

Encoded string to continue paging.

Request body

The request body must be empty.

Response body

A list of WorkerPool resources.

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

JSON representation
{
  "apiVersion": string,
  "kind": string,
  "metadata": {
    object (ListMeta)
  },
  "items": [
    {
      object (WorkerPool)
    }
  ],
  "unreachable": [
    string
  ]
}
Fields
apiVersion

string

The API version for this call; returns "run.googleapis.com/v1".

kind

string

The kind of this resource; returns "WorkerPoolList".

metadata

object (ListMeta)

Metadata associated with this WorkerPool list.

items[]

object (WorkerPool)

List of WorkerPools.

unreachable[]

string

For calls against the global endpoint, returns the list of Cloud locations that could not be reached. For regional calls, this field is not used.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.