管理代理程式集區

代理程式集區是一組代理程式,使用相同的設定,並對來源和目的地具有一致的存取權和瀏覽權限。代理程式集區也提供轉移頻寬限制的控制選項。

所有代理程式都必須屬於代理程式集區。

本指南說明如何使用代理程式集區。

事前準備

您必須具備專案的適當權限,才能使用代理程式集區。詳情請參閱「使用 IAM 控管存取權」。

您可以查看目前的權限。

如要使用 gcloud 指令,請安裝 gcloud 指令列工具。

建立代理程式集區

請勿在代理程式集區名稱或代理程式 ID 前置字串中加入機密資訊,例如個人識別資訊 (PII) 或安全性資料。資源名稱可能會傳播至其他 Google Cloud 資源的名稱,並可能在專案外部向 Google 內部系統公開。

如要建立代理程式集區,請按照下列步驟操作:

Google Cloud 控制台

  1. 前往 Google Cloud 控制台的「Agent pools」(代理程式集區) 頁面。

    前往「Agent pools」(代理程式集區) 頁面

    系統會顯示「Agent pools」(代理程式集區) 頁面,列出您現有的代理程式集區。

  2. 按一下「建立其他集區」。

  3. 為集區命名,並視需要輸入說明。

  4. 您可以選擇設定頻寬限制,套用至整個集區。指定頻寬 (以 MB/s 為單位) 會分配給集區中的所有代理程式。詳情請參閱「管理網路頻寬」。

  5. 點選「建立」。

REST API

使用 projects.agentPools.create:

POST https://storagetransfer.googleapis.com/v1/projects/PROJECT_ID/agentPools?agent_pool_id=AGENT_POOL_ID

更改下列內容:

  • PROJECT_ID:要建立代理程式集區的專案 ID。
  • AGENT_POOL_ID:要建立的代理程式集區 ID。

如果代理程式集區卡在 Creating 狀態超過 30 分鐘,建議您刪除代理程式集區並重新建立。

如果代理程式集區處於 Creating 狀態,撤銷專案所需的 Storage 移轉服務權限會導致服務行為不正確。

gcloud CLI

如要使用 gcloud 指令列工具建立代理程式集區,請執行 gcloud transfer agent-pools create。

gcloud transfer agent-pools create AGENT_POOL

可用的選項如下:

  • AGENT_POOL 是這個集區的專屬永久 ID。

  • --no-async 會封鎖終端機中的其他工作,直到集區建立完成為止。如未提供,集區建立作業會以非同步方式執行。

  • --bandwidth-limit 定義要提供給這個集區代理程式的頻寬 (以 MB/s 為單位)。頻寬限制適用於集區中的所有代理程式,可防止集區的移轉工作負載干擾共用頻寬的其他作業。例如,輸入「50」即可將頻寬限制設為 50 MB/s。如未指定這個旗標,這個集區的代理程式將使用所有可用頻寬。

  • --display-name 是可修改的名稱,方便您識別這個集區。您可以加入集區專屬完整資源名稱中可能不適合的詳細資料。

將代理指派給集區

新的代理程式集區是空的,必須指派代理程式。代理程式只能在建立時指派給代理程式集區。

如未指定代理程式集區,代理程式會指派至 transfer_service_default 集區。

如要建立代理程式並指派給集區,請按照下列步驟操作:

Google Cloud 控制台

  1. 在「Agent pools」(代理程式集區) 頁面中,選取要指派代理程式的集區。

  2. 按一下「Install agent」(安裝代理程式)。系統隨即會顯示代理程式安裝指南。

  3. 按照操作說明,在這個代理程式集區中建立代理程式。

gcloud CLI

如要使用 gcloud 指令列工具建立代理程式並指派給集區,請執行 gcloud transfer agents install。代理程式必須安裝在具有檔案系統根層級存取權的機器上。

gcloud transfer agents install --pool=AGENT_POOL

如要安裝代理程式,以便與 S3 相容來源搭配使用,請提供存取憑證,方法是將憑證設為環境變數 (AWS_ACCESS_KEY_ID 和 AWS_SECRET_ACCESS_KEY 的值),或將憑證儲存為系統設定檔中的預設憑證。

export AWS_ACCESS_KEY_ID=ID
export AWS_SECRET_ACCESS_KEY=SECRET
gcloud transfer agents install --pool=AGENT_POOL

詳情請參閱「管理移轉代理程式」。

如需其他選項,請參閱「進階代理程式選項」。

如要管理代理,請參閱「管理移轉代理」。

將代理程式集區指派給工作

建立代理程式集區後,您可以在建立或更新工作時,將集區指派給工作。

更新代理程式集區

您可以更新代理程式集區的顯示名稱和頻寬限制。

如要更新代理程式集區,請按照下列步驟操作:

Google Cloud 控制台

前往 Google Cloud 控制台的「Agent pools」(代理程式集區) 頁面。

前往「Agent pools」(代理程式集區) 頁面

可編輯的項目包括:

  • 代理程式集區的顯示名稱:按一下目前「Agent pool」(代理程式集區) 名稱旁的 「Edit」(編輯)。

  • 代理程式集區的頻寬限制:按一下「Set bandwidth limit」(設定頻寬限制),然後在「Set bandwidth limit」(設定頻寬限制) 對話方塊中輸入新的頻寬限制。按一下「設定限制」,套用新的頻寬限制。頻寬會由集區中的所有代理程式共用。

REST API

如要更新代理程式集區,請使用 projects.agentPools.patch,並為要更新的欄位加上欄位遮罩。您可以更新下列代理程式集區欄位:

舉例來說,如果只要更新顯示名稱,請將 updateMask 查詢參數設為 displayName,並在要求主體中提供新值。

以下是更新顯示名稱的修補要求範例:

PATCH https://storagetransfer.googleapis.com/v1/projects/PROJECT_ID/agentPools/AGENT_POOL?updateMask=displayName
{
"displayName": "NEW_DISPLAY_NAME"
}

更改下列內容:

  • PROJECT_ID:要更新代理程式集區的專案 ID。
  • AGENT_POOL:要更新的代理程式集區名稱。
  • NEW_DISPLAY_NAME:這個 代理程式集區的新顯示名稱。

以下是更新頻寬限制的修補要求範例:

PATCH https://storagetransfer.googleapis.com/v1/projects/PROJECT_ID/agentPools/AGENT_POOL?updateMask=bandwidthLimit
{
"bandwidthLimit": {
  "limitMbps": "NEW_LIMIT"
}
}

更改下列內容:

  • PROJECT_ID:要更新代理程式集區的專案 ID。
  • AGENT_POOL:要更新的代理程式集區 ID。
  • NEW_LIMIT:這個代理程式集區的新頻寬限制,以 MBps (每秒 MB 數) 為單位。

gcloud CLI

如要使用 gcloud 指令列工具更新代理程式集區,請執行 gcloud transfer agent-pools update。

gcloud transfer agent-pools update AGENT_POOL \
  [--bandwidth-limit=NEW_BANDWIDTH_LIMIT] [--clear-bandwidth-limit] \
  [--clear-display-name] [--display-name=NEW_DISPLAY_NAME]

必須提供下列引數:

  • AGENT_POOL 是這個集區的專屬永久 ID。AGENT_POOL 會識別要更新的代理程式集區,本身無法更新。

這個指令可指定下列旗標:

  • 您可以更新 --bandwidth-limit,或改為指定 --clear-bandwidth-limit 來移除。如要進一步瞭解頻寬限制,請參閱「建立代理程式集區」。

  • 您可以使用 --clear-display-name 旗標更新或刪除 --display-name。

刪除代理程式集區

您可以刪除沒有任何執行中代理程式和工作執行的代理程式集區。

如要刪除代理集區,請按照下列步驟操作:

Google Cloud 控制台

  1. 前往 Google Cloud 控制台的「Agent pools」(代理程式集區) 頁面。

    前往「Agent pools」(代理程式集區) 頁面

  2. 按一下「刪除」圖示 。閱讀彈出式視窗,然後按一下「Delete」(刪除) 確認。

    如果刪除按鈕未啟用,請停止與這個集區相關聯的所有代理程式和工作。

REST API

使用 projects.agentPools.delete:

DELETE https://storagetransfer.googleapis.com/v1/projects/PROJECT_ID/agentPools/AGENT_POOL

更改下列內容:

  • PROJECT_ID:要刪除代理程式集區的專案 ID。
  • AGENT_POOL:代理程式集區名稱。

gcloud CLI

如要使用 gcloud 指令列工具刪除代理程式集區,請執行 gcloud transfer agent-pools delete。

gcloud transfer agent-pools delete AGENT_POOL

必須提供下列引數:

  • AGENT_POOL 是這個集區的專屬永久 ID。

如要刪除集區,必須先停止集區中的所有代理程式、停用集區的工作,且集區沒有進行中的移轉作業。

如要查看與集區相關聯的所有工作,請在 Google Cloud 控制台中選取集區,然後按一下「Transfer jobs」(移轉工作) 分頁標籤。

取得代理程式集區

如何取得代理程式集區:

Google Cloud 控制台

前往 Google Cloud 控制台的「Agent pools」(代理程式集區) 頁面。

前往「Agent pools」(代理程式集區) 頁面

這個頁面會列出與專案相關聯的所有代理程式集區,以及各集區的下列資訊:

  • 代理程式集區名稱
  • 連線狀態
  • 已連線的代理程式數量
  • 頻寬限制 (如有設定)
  • 相關聯的移轉工作數量
  • 代理集區的顯示名稱

如要查看特定代理程式集區,請按一下代理程式集區的「Name」(名稱)。

您可以在代理程式集區的資訊頁面執行下列動作:

  • 安裝代理程式:顯示安裝移轉代理程式的操作說明。
  • 停止代理:在表格中選取代理,然後按一下「停止代理」。
  • 列出移轉工作:按一下「Transfer Jobs」(移轉工作),即可顯示這個集區中代理程式連結的移轉工作。

REST API

使用 projects.agentPools.get:

GET https://storagetransfer.googleapis.com/v1/projects/PROJECT_ID/agentPools/AGENT_POOL

更改下列內容:

  • PROJECT_ID:要取得代理程式集區的專案 ID。
  • AGENT_POOL:要擷取的代理程式集區。

gcloud CLI

如要使用 gcloud 指令列工具擷取代理程式集區,請執行 gcloud transfer agent-pools describe。

gcloud transfer agent-pools describe AGENT_POOL

必須提供下列引數:

  • AGENT_POOL 是這個集區的專屬永久 ID。

列出代理程式集區

如要列出代理程式集區,請按照下列步驟操作:

Google Cloud 控制台

前往 Google Cloud 控制台的「Agent pools」(代理程式集區) 頁面。

前往「Agent pools」(代理程式集區) 頁面

系統會顯示所有代理程式集區。

REST API

使用 projects.agentPools.list:

GET https://storagetransfer.googleapis.com/v1/projects/PROJECT_ID/agentPools

更改下列內容:

  • PROJECT_ID:要列出代理程式集區的專案 ID。

gcloud CLI

如要使用 gcloud 指令列工具列出代理程式集區,請執行 gcloud transfer agent-pools list。

gcloud transfer agent-pools list \
  [--limit=LIMIT] \
  [--names=[NAMES,...]] \
  [--page-size=PAGE_SIZE]

這個指令可指定下列旗標:

  • --limit 定義要傳回的代理程式集區數量上限。

  • --names 指定要列出的代理集區名稱。請以半形逗號分隔多個名稱,例如 --names=foo,bar。如未指定,系統會列出目前專案中的所有代理程式集區。

  • --page-size 會定義這個指令的批次處理行為。根據預設,list 指令會將回應批次處理為 256 個項目,並自動擷取下一個批次,直到列出所有項目或達到 limit 為止。

這個指令會傳回相符的代理程式集區清單及其設定詳細資料。以下是回應範例。

name: projects/my-project-123/agentPools/my-first-pool
state: CREATED
---
bandwidthLimit:
  limitMbps: '120'
displayName: Source A to destination Z.
name: projects/my-project-123/agentPools/a2z-pool
state: CREATED