Method: projects.agentPools.list

Lists agent pools.

HTTP request

GET https://storagetransfer.googleapis.com/v1/projects/{projectId}/agentPools

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
projectId

string

Required. The ID of the Google Cloud project that owns the job.

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

  • storagetransfer.agentpools.list

Query parameters

Parameters
filter

string

An optional list of query parameters specified as JSON text in the form of:

{"agentPoolNames":["agentpool1","agentpool2",...]}

Since agentPoolNames support multiple values, its values must be specified with array notation. When the filter is either empty or not provided, the list returns all agent pools for the project.

pageSize

integer

The list page size. The max allowed value is 256.

pageToken

string

The list page token.

Request body

The request body must be empty.

Response body

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

Response from agentPools.list.

JSON representation
{
  "agentPools": [
    {
      object (AgentPool)
    }
  ],
  "nextPageToken": string
}
Fields
agentPools[]

object (AgentPool)

A list of agent pools.

nextPageToken

string

The list next page token.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.