エージェント プールの管理

エージェントは、Transfer Service for On Premises Data が Cloud Storage にデータを転送するために使用されるソフトウェアです。エージェント プールは、ソースと移行先への統一されたアクセスと可視性を持つ、同じ構成を使用するエージェントの集合です。

このガイドでは、Transfer Service for On Premises Data エージェント プールの使用方法について説明します。

始める前に

エージェント プールを操作するには、プロジェクトに対する特定の権限が必要です。権限とロールの詳細については、IAM によるアクセス制御をご覧ください。

現在の権限を表示できます。

エージェント プールの作成

エージェント プールを作成するには:

Cloud Console

  1. Cloud Console で、[Transfer Service for On Premises Data] ページに移動します。

    [Transfer Service for On Premises Data] に移動

  2. [接続設定] をクリックします。

    [エージェント プール] ページが開き、既存のエージェント プールが一覧表示されます。すべてのプロジェクトに transfer_service_default という名前のデフォルト プールが含まれています。

  3. [別のプールを作成] をクリックします。

  4. プールに名前を付け、必要に応じて説明を入力します。

  5. プール全体に適用される帯域幅上限を設定できます。指定された帯域幅(MB/秒)は、プール内のすべてのエージェント間で分割されます。

  6. [作成] をクリックします。

REST API

projects.agentPools.create を使用します。

POST https://storagetransfer.googleapis.com/v1/projects/{PROJECT_ID}/agentPools/{agent_pool_id=AGENT_POOL_ID}:create

ここで

  • PROJECT_ID: エージェント プールを作成するプロジェクト ID。
  • AGENT_POOL_ID: 作成するエージェント プール ID。

エージェント プールが Creating 状態で 30 分以上停止している場合は、エージェント プールを削除して再作成することをおすすめします。

エージェント プールが Creating 状態にあるときに、プロジェクトから必須のオンプレミス用 Transfer 権限を取り消すと、誤ったサービス動作が発生します。

エージェントをプールに割り当てる

新しいエージェント プールは空です。エージェントを割り当てる必要があります。エージェントを割り当てるには、エージェントの作成時にエージェント プールにのみ --agent-pool フィールドを使用します。

--agent-pool が指定されていない場合、エージェントが transfer_service_default プールに割り当てられます。

エージェントを作成してプールに割り当てるには:

  1. [エージェント プール] ページで、エージェントを割り当てるプールを選択します。

  2. [エージェントをインストール] をクリックします。エージェント インストール ガイドが表示されます。

  3. 手順に沿って、このエージェント プールにエージェントを作成します。

その他のオプションについては、高度なエージェントの設定をご覧ください。

エージェントを管理するには、オンプレミス用 Transfer エージェントの管理をご覧ください。

エージェント プールをジョブに割り当てる

エージェント プールが作成されたら、ジョブの作成または更新中に、エージェント プールをジョブに割り当てることができます。

エージェント プールの更新

エージェント プールの表示名と帯域幅上限を更新できます。

エージェント プールを更新するには:

Cloud Console

Cloud Console で、[エージェント プール] ページに移動します。

[エージェント プール] に移動

次の項目を編集できます。

  • エージェント プールの表示名: 現在のエージェント プール名の横にある [編集] をクリックします。

  • エージェント プールの帯域幅上限: [帯域幅の上限を設定] をクリックし、[帯域幅の上限を設定] ダイアログで新しい帯域幅の上限を入力します。[上限を設定] をクリックして、新しい帯域幅上限を適用します。帯域幅はプール内のすべてのエージェントで共有されます。

REST API

エージェント プールを更新するには、更新するフィールドのフィールド マスクを指定して projects.agentPools.patch を使用します。次のエージェント プール フィールドを更新できます。

たとえば、displayNamemy-transfer に更新するには、フィールド マスク "displayName,my-transfer" を指定します。

表示名を更新するパッチ リクエストの例を次に示します。

PATCH https://storagetransfer.googleapis.com/v1/projects/{PROJECT_ID}/agentPools/{AGENT_POOL_ID}:"displayName,NEW_NAME"

ここで

  • PROJECT_ID: エージェント プールを更新するプロジェクト ID。
  • AGENT_POOL_ID: 更新するエージェント プール ID。
  • NEW_NAME: このエージェント プールの新しい表示名。

次に、帯域幅上限を更新するパッチ リクエストの例を示します。

PATCH https://storagetransfer.googleapis.com/v1/projects/{PROJECT_ID}/agentPools/{AGENT_POOL_ID}:"bandwidthLimit,NEW_LIMIT"

ここで

  • PROJECT_ID: エージェント プールを更新するプロジェクト ID。
  • AGENT_POOL_ID: 更新するエージェント プール ID。
  • NEW_LIMIT: このエージェント プールの新しい帯域幅上限。

エージェント プールの削除

アクティブなエージェントがなく、アクティブなジョブ実行がないエージェント プールは削除できます。

エージェント プールを削除するには:

Cloud Console

  1. Cloud Console で、[エージェント プール] ページに移動します。

    [エージェント プール] に移動

  2. [削除] をクリックします。ポップアップの内容を確認し、[削除] をクリックして確定します。

    削除ボタンがアクティブでない場合は、このプールに関連付けられているすべてのエージェントとジョブを停止する必要があります。

REST API

projects.agentPools.delete を使用します。

DELETE https://storagetransfer.googleapis.com/v1/{name=PROJECT_ID/*/agentPools/}

ここで

  • PROJECT_ID: エージェント プールを削除するプロジェクト ID。

エージェント プールの取得

エージェント プールを取得するには:

Cloud Console

Cloud Console で、[エージェント プール] ページに移動します。

[エージェント プール] に移動

このページには、プロジェクトに関連付けられているすべてのエージェント プールのリストと、各エージェント プールの次の情報が表示されます。

  • エージェント プール名
  • 接続ステータス
  • 接続済みのエージェントの数
  • 帯域幅の上限(設定されている場合)
  • 関連付けられている転送ジョブの数
  • エージェント プールの表示名

特定のエージェント プールを表示するには、エージェント プールの [名前] をクリックします。

エージェント プールの情報ページでは、次の操作を行うことができます。

  • エージェントのインストール: オンプレミス用 Transfer エージェントをインストールする手順を表示します。
  • エージェントの停止: テーブルでエージェントを選択して、[STOP AGENT] をクリックします。
  • 転送ジョブを一覧表示する: [転送ジョブ] をクリックして、このプールのエージェントが接続されている転送ジョブを表示します。

REST API

projects.agentPools.get を使用します。

GET https://storagetransfer.googleapis.com/v1/{name=PROJECT_ID/*/agentPools/}

ここで

  • PROJECT_ID: エージェント プールを取得するプロジェクト ID。

エージェント プールの一覧表示

エージェント プールを一覧表示するには:

Cloud Console

Cloud Console で、[エージェント プール] ページに移動します。

[エージェント プール] に移動

すべてのエージェント プールが表示されます。

REST API

projects.agentPools.list を使用します。

GET https://storagetransfer.googleapis.com/v1/projects/{project_id=PROJECT_ID}/agentPools

ここで

  • PROJECT_ID: エージェント プールを取得するプロジェクト ID。