Method: projects.agentPools.list

エージェント プールを一覧表示します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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 をご覧ください。