管理代理池

代理是 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/s 为单位的指定带宽将在池中的所有代理之间拆分。

  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 状态时,撤消项目所需的本地转移权限会导致服务行为不正确。

将代理分配给池

新代理池为空,且必须为其分配代理。只能使用 --agent-pool 字段在创建代理时将代理分配给代理池。

如果未指定 --agent-pool,则代理会分配给 transfer_service_default 池。

要创建代理并将其分配给池,请执行以下操作:

  1. 代理池页面中,选择要向其分配代理的池。

  2. 点击安装代理。此时将显示代理安装指南。

  3. 按照说明在此代理池中创建代理。

如需了解其他选项,请参阅高级代理设置

如需管理代理,请参阅管理本地转移代理

将代理池分配给作业

创建代理池后,可以在作业创建或更新期间将其分配给作业。

更新代理池

您可以更新代理池的显示名和带宽限制。

如需更新代理池,请执行以下操作:

Cloud Console

在 Cloud Console 中,转到代理池页面。

转到“代理池”

您可以修改以下各项:

  • 代理池的显示名:点击当前代理池名称旁边的修改

  • 代理池的带宽限制:点击设置带宽限制,然后在设置带宽限制对话框中输入新的带宽限制。点击设置限制以应用新的带宽限制。 带宽会在池中的所有代理之间共享。

REST API

要更新代理池,请使用 projects.agentPools.patch 和要更新的字段的字段掩码。您可以更新以下代理池字段:

例如,要将 displayName 更新为 my-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 中,转到代理池页面。

转到“代理池”

该页面显示与项目关联的所有代理池的列表,以及每个代理池的以下信息:

  • 代理池名称
  • 连接状态
  • 连接的代理数
  • 带宽限制(如果已设置)
  • 关联的转移作业的数量
  • 代理池的显示名称

如需查看特定代理池,请点击代理池的名称

您可以在代理池的信息页面中执行以下操作:

  • 安装代理:显示有关安装本地转移代理的说明。
  • 停止代理:在表格中选择代理,然后点击停止代理 (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。