Method: projects.agentPools.list

列出代理池。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
projectId

string

必需。作业所属的 Google Cloud 项目的 ID。

必须对指定的资源 projectId 具有以下 IAM 权限才能进行授权:

  • storagetransfer.agentpools.list

查询参数

参数
filter

string

可选的查询参数列表,以 JSON 文本的形式指定,格式为:

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

由于 agentPoolNames 支持多个值,因此必须使用数组表示法指定其值。如果过滤条件为空或未提供,列表会返回项目的所有代理池。

pageSize

integer

列表页面大小。允许的最大值为 256

pageToken

string

列表页面令牌。

请求正文

请求正文必须为空。

响应正文

agentPools.list 的响应。

如果成功,响应正文将包含结构如下的数据:

JSON 表示法
{
  "agentPools": [
    {
      object (AgentPool)
    }
  ],
  "nextPageToken": string
}
字段
agentPools[]

object (AgentPool)

代理池列表。

nextPageToken

string

列表下一页令牌。

授权范围

需要以下 OAuth 范围:

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

如需了解详情,请参阅 Authentication Overview