FTP

FTP 連接器可讓您連線至 FTP 伺服器,並執行檔案傳輸作業。

事前準備

使用 FTP 連接器前,請先完成下列工作:

  • 在 Google Cloud 專案中:
    • 確認已設定網路連線。如要瞭解網路模式,請參閱「網路連線」。
    • roles/connectors.admin IAM 角色授予設定連線器的使用者。
    • 將下列 IAM 角色授予要用於連接器的服務帳戶:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      服務帳戶是特殊的 Google 帳戶類型,主要用於代表需要驗證且必須取得授權才能存取 Google API 資料的非人類使用者。如果您沒有服務帳戶,請建立服務帳戶。詳情請參閱「建立服務帳戶」。

    • 啟用下列服務:
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connectors API)

      如要瞭解如何啟用服務,請參閱「啟用服務」。

    如果專案先前未啟用這些服務或權限,系統會在設定連結器時提示您啟用。

設定連接器

連線專屬於資料來源。也就是說,如果您有多個資料來源,則必須為每個資料來源建立個別的連線。如要建立連線,請按照下列步驟操作:

  1. Cloud 控制台中,前往「Integration Connectors」>「Connections」頁面,然後選取或建立 Google Cloud 專案。

    前往「連線」頁面

  2. 按一下「+ 建立新項目」開啟「建立連線」頁面。
  3. 在「位置」部分中,選擇連線位置。
    1. 區域:從下拉式清單中選取位置。

      如需所有支援的地區清單,請參閱「位置」一文。

    2. 點選「下一步」
  4. 在「連線詳細資料」部分,完成下列步驟:
    1. 連接器:從可用連接器的下拉式清單中選取「FTP」
    2. 連接器版本:從可用版本的下拉式清單中選取連接器版本。
    3. 在「連線名稱」欄位中,輸入連線執行個體的名稱。

      連線名稱必須符合下列條件:

      • 連線名稱可使用英文字母、數字或連字號。
      • 字母必須為小寫。
      • 連線名稱開頭須為英文字母,結尾則須為英文字母或數字。
      • 連結名稱不得超過 49 個字元。
    4. 視需要輸入連線執行個體的「Description」(說明)
    5. 或者,可啟用 Cloud Logging,然後選取記錄層級。記錄層級預設為 Error
    6. 服務帳戶:選取具備必要角色的服務帳戶。
    7. 視需要設定「連線節點設定」

      • 節點數量下限:輸入連線節點數量下限。
      • 節點數量上限:輸入連線節點數量上限。

      節點是用來處理交易的連線單位 (或備用資源)。連線處理的交易量越多,就需要越多節點;反之,處理的交易量越少,需要的節點就越少。如要瞭解節點對連接器定價的影響,請參閱「 連線節點定價」。如未輸入任何值,系統預設會將節點下限設為 2 (提高可用性),節點上限則設為 50。

    8. 檔案擷取深度:指定要從根目錄資料表查詢的資料夾深度層級。
    9. 被動:控制是否要將伺服器導向被動模式。如果位於防火牆後方,建議使用這個選項。
    10. 遠端路徑:FTP 伺服器中的目前路徑。
    11. SSL 模式:連線至 FTP 伺服器時使用的驗證機制。
    12. 資料表深度:顯示子資料夾做為檢視區塊的深度層級。
    13. 使用 MLSD:使用房源資訊進行機器處理。僅適用於 FTP 伺服器。
    14. (選用) 按一下「+ 新增標籤」,以鍵/值組合的形式為連線新增標籤。
    15. 點選「下一步」
  5. 在「目的地」部分,輸入要連線的遠端主機 (後端系統) 詳細資料。
    1. 目的地類型:選取目的地類型
      • 如要指定目的地主機名稱或 IP 位址,請選取「主機地址」,然後在「主機 1」欄位中輸入地址。
      • 如要建立私人連線,請選取「Endpoint attachment」(端點連結),然後從「Endpoint Attachment」(端點連結) 清單中選擇所需連結。

      如要建立與後端系統的公開連線,並加強安全性,建議為連線設定靜態輸出 IP 位址,然後設定防火牆規則,只允許特定靜態 IP 位址。

      如要輸入其他目的地,請按一下「+新增目的地」

    2. 點選「下一步」
  6. 在「Authentication」(驗證) 部分中,輸入驗證詳細資料。
    1. 選取「驗證類型」並輸入相關詳細資料。

      FTP 連線支援下列驗證類型:

      • 使用者名稱和密碼
    2. 如要瞭解如何設定這些驗證類型,請參閱「設定驗證」。

    3. 點選「下一步」
  7. 檢查:檢查連線和驗證詳細資料。
  8. 點選「建立」

設定驗證機制

根據要使用的驗證方式輸入詳細資料。

  • 使用者名稱和密碼
    • 使用者名稱:用於連線的 FTP 使用者名稱。
    • 密碼:Secret Manager 密鑰,內含與 FTP 使用者名稱相關聯的密碼。

實體、作業和動作

所有整合連接器都會為所連應用程式的物件提供抽象層。您只能透過這個抽象化程序存取應用程式的物件。抽象化會以實體、作業和動作的形式呈現。

  • 實體: 實體可以視為已連結應用程式或服務中的物件,或是屬性集合。實體的定義因連接器而異。舉例來說,在資料庫連接器中,資料表是實體;在檔案伺服器連接器中,資料夾是實體;在訊息系統連接器中,佇列是實體。

    不過,連接器可能不支援或沒有任何實體,在這種情況下,Entities 清單會是空白。

  • 作業: 作業是指您可以在實體上執行的活動。您可以對實體執行下列任一操作:

    從可用清單中選取實體,系統會產生該實體可用的作業清單。如需作業的詳細說明,請參閱 Connectors 工作的實體作業。 不過,如果連接器不支援任何實體作業,系統就不會在 Operations 清單中列出這些不支援的作業。

  • 動作: 動作是透過連接器介面提供給整合的第一類函式。動作可讓您變更一或多個實體,且因連接器而異。一般來說,動作會有一些輸入參數和輸出參數。不過,連接器可能不支援任何動作,此時 Actions 清單會是空白。

系統限制

FTP 連接器每秒可處理 1 筆交易,每個節點也是如此,且會節流任何超出此限制的交易。根據預設,Integration Connectors 會為連線分配 2 個節點 (以提高可用性)。

如要瞭解 Integration Connectors 適用的限制,請參閱「限制」一文。

動作

本節列出連接器支援的部分動作。如要瞭解如何設定動作,請參閱「動作範例」。

上傳動作

下表說明 Upload 動作的輸入參數。

參數名稱 資料類型 必填 說明
內容 字串 要上傳的內容 (以檔案形式)。
ContentBytes 字串 要以檔案形式上傳的位元組內容 (Base64 編碼字串)。用來上傳二進位資料。
HasBytes 布林值 指定是否應以位元組形式上傳內容。預設值為 false
RemoteFile 字串 遠端主機上的檔案名稱。
覆寫 布林值 指定是否要覆寫遠端檔案。預設值為 false

如需如何設定 Upload 動作的範例,請參閱「範例」。

下載動作

下表說明 Download 動作的輸入參數。

參數名稱 資料類型 必填 說明
RemoteFile 字串 遠端主機上的檔案名稱。
HasBytes 布林值 指定是否應以位元組形式下載內容。預設值為 false

如需如何設定 Download 動作的範例,請參閱「範例」。

MoveFile 動作

下表說明 MoveFile 動作的輸入參數。

參數名稱 資料類型 必填 說明
RemoteFile 字串 要移動的遠端檔案路徑。
DestinationPath 字串 要將檔案移至的新路徑。

如需如何設定 MoveFile 動作的範例,請參閱「範例」。

RenameFile 動作

下表說明 RenameFile 動作的輸入參數。

參數名稱 資料類型 必填 說明
RemoteFile 字串 要重新命名的遠端檔案路徑和名稱。
NewFileName 字串 遠端檔案的新名稱。

如需如何設定 RenameFile 動作的範例,請參閱「範例」。

範例

本節說明如何使用這個連接器執行部分實體作業和動作。 這些範例說明下列作業:

  • 列出根目錄中的所有檔案
  • 列出目錄中符合模式的檔案
  • 移動檔案
  • 重新命名檔案
  • 刪除檔案
  • 上傳 ASCII 文字檔
  • 上傳二進位檔案
  • 下載 ASCII 文字檔
  • 下載二進位檔案

下表列出範例情境,以及「連線器」工作中的對應設定:

工作 指令範例 設定
列出根目錄中的所有檔案 ls /
  1. 在「Configure connector task」對話方塊中,按一下 Entities
  2. 選取 Root 實體,然後選取 List 作業。
  3. 按一下 [完成]
列出目錄中的 .csv 檔案 ls /tmp/*.csv
  1. 在「Configure connector task」對話方塊中,按一下 Entities
  2. Entity 清單中選取基本目錄 (/tmp)。
  3. 選取「List」作業,然後按一下「完成」
  4. 設定篩選器子句。如要設定子句,請在「Connectors」(連結器) 工作的「Task Input」(工作輸入) 區段中,按一下「filterClause」(篩選子句),然後在「Default Value」(預設值) 欄位中輸入 FilePath LIKE '/tmp/%.csv'
移動檔案 mv /tmp/dir_A/hello_world.txt /dir_B/dir_C/
  1. 在「Configure connector task」對話方塊中,按一下 Actions
  2. 選取 MoveFile 動作,然後按一下「完成」
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入類似下列的值:
    {
    "RemoteFile": "/tmp/dir_A/hello_world.txt",
    "DestinationPath": "/dir_B/dir_C/"
    }

這個範例會將 /tmp/dir_A/hello_world.txt 檔案移至 /dir_B/dir_C/ 目錄。執行這個範例後,會在連接器工作的 connectorOutputPayload 輸出變數中傳回類似下列內容的回應:

[{
"Success":"true"
}]
重新命名檔案 mv /tmp/hello_world.txt /tmp/hello_world_new.txt
  1. 在「Configure connector task」對話方塊中,按一下 Actions
  2. 選取 RenameFile 動作,然後按一下「完成」
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入類似下列的值:
    {
    "RemoteFile": "/tmp/hello_world.txt",
    "NewFilename": "hello_world_new.txt"
    }

這個範例會將 hello_world.txt 檔案重新命名為 hello_world_new.txt。執行這個範例後,會在連接器工作的 connectorOutputPayload 輸出變數中傳回類似下列內容的回應:

[{
"Success":"true"
}]
刪除檔案 rm /tmp/myfile.csv
  1. 在「Configure connector task」對話方塊中,按一下 Entities
  2. Entity 清單中,選取要移動檔案的基底目錄。
  3. 選取「Delete」作業,然後按一下「完成」
  4. 將實體 ID 設為檔案的完整路徑。如要設定實體 ID,請在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 部分中,按一下「entityId」 ,然後在「Default Value」(預設值) 欄位中輸入 /tmp/myfile.csv

    或者,您也可以將 filterClause 設為 FilePath LIKE '/tmp/myfile.csv',而非指定 entityId

上傳 ASCII 文字檔 put file_1.txt /tmp/file_1.txt
  1. 在「Configure connector task」對話方塊中,按一下 Actions
  2. 選取 Upload 動作,然後按一下「完成」
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入下列內容:
    {
      "Content": "This is a sample text!\r\n",
      "RemoteFile": "/tmp/file_1.txt",
      "Overwrite": true
    }
  4. 這個範例會建立 file_1.txt 檔案,其中包含 FTP 伺服器 /tmp 目錄中的 This is a sample text! 內容。由於 Overwrite 屬性值為 true,因此系統會覆寫任何同名的現有檔案。

    Overwrite 屬性為選用屬性,預設值為 false

上傳二進位檔案 put image_1.png /tmp/image_1.png 如要上傳二進位內容,請先將內容編碼為 Base64 格式。你可以選擇偏好的工具來編碼內容。內容編碼步驟不在本文的討論範圍內。取得內容的 Base64 字串後,請執行下列步驟:
  1. 在「Configure connector task」對話方塊中,按一下 Actions
  2. 選取 Upload 動作,然後按一下「完成」
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入下列內容:
    {
      "ContentBytes": "SGVsbG8gd29ybGQ=",
      "RemoteFile": "/tmp/image_1.png",
      "Overwrite": true,
      "HasBytes": true
    }
  4. 這個範例會建立 image_1.png 檔案,並將內容設為 ContentBytes 欄位中指定的值。檔案會在 FTP 伺服器的 /tmp 目錄中建立。由於 Overwrite 屬性值為 true,因此系統會覆寫任何同名的現有檔案。

    Overwrite 屬性為選用屬性,預設值為 false

下載 ASCII 文字檔 get /tmp/myfile.txt
  1. 在「Configure connector task」對話方塊中,按一下 Actions
  2. 選取 Download 動作,然後按一下「完成」
  3. 在「Connectors」(連結器) 任務的「Task Output」(任務輸出內容) 區段中,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入下列內容:
    {
    "RemoteFile": "/tmp/myfile.txt"
    }

下載檔案的內容會以字串形式,顯示在連線器工作 connectorOutputPayload 回應參數的 Content 欄位中。

下載二進位檔案 get /tmp/myfile.png
  1. 在「Configure connector task」對話方塊中,按一下 Actions
  2. 選取 Download 動作,然後按一下「完成」
  3. 在「Connectors」(連結器) 任務的「Task Output」(任務輸出內容) 區段中,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入下列內容:
    {
    "RemoteFile": "/tmp/myfile.png",
    "HasBytes" : true
    }

下載檔案的內容會以 Base64 編碼字串的形式,顯示在 Connector 工作 connectorOutputPayload 回應參數的 ContentBytes 欄位中。

酬載的 JSON 結構定義

FTP 連線中的所有實體物件都有預先定義的 JSON 結構定義。充分瞭解架構後,您就能輕鬆設定輸入或輸出酬載值。FTP 連線中的實體物件使用下列 JSON 結構定義:

  {
    "type": "object",
    "properties": {
      "FilePath": {
        "type": "string",
        "readOnly": false
      },
      "Filename": {
        "type": [
          "string",
          "null"
        ],
        "readOnly": false,
        "description": "The name of the file or directory."
      },
      "FileSize": {
        "type": [
          "number",
          "null"
        ],
        "readOnly": false,
        "description": "The size of the file."
      },
      "LastModified": {
        "type": [
          "string",
          "null"
        ],
        "readOnly": false
      },
      "IsDirectory": {
        "type": [
          "boolean",
          "null"
        ],
        "readOnly": false
      },
      "Permissions": {
        "type": [
          "string",
          "null"
        ],
        "readOnly": false
      },
      "Owner": {
        "type": [
          "string",
          "null"
        ],
        "readOnly": false
      },
      "OwnerId": {
        "type": [
          "string",
          "null"
        ],
        "readOnly": false
      },
      "Group": {
        "type": [
          "string",
          "null"
        ],
        "readOnly": false
      },
      "GroupId": {
        "type": [
          "string",
          "null"
        ],
        "readOnly": false
      }
    }
  }

動態設定 filterClause

對於「列出」、「更新」和「刪除」作業,您可以在整合作業中使用「資料對應」工作,在執行階段動態設定 filterClasue 輸入變數的值。舉例來說,在整合中叫用 API 觸發程序時,您可能想傳送篩選子句的值。下圖顯示資料對應工作資料對應編輯器中 filterClause 變數的範例對應: 在資料對應編輯器中設定篩選子句

使用 Terraform 建立連線

您可以使用 Terraform 資源建立新連線。

如要瞭解如何套用或移除 Terraform 設定,請參閱「基本 Terraform 指令」。

如要查看用於建立連線的 Terraform 範本範例,請參閱範本範例

使用 Terraform 建立這項連線時,您必須在 Terraform 設定檔中設定下列變數:

參數名稱 資料類型 必填 說明
file_retrieval_depth STRING 從根資料表指定要查詢的資料夾深度層級。
被動 BOOLEAN 控制是否要將伺服器導向被動模式。如果位於防火牆後方,建議使用這個選項。
remote_path STRING FTP 伺服器中的目前路徑。
table_depth INTEGER 顯示子資料夾做為檢視畫面的深度層級。
use_mlsd BOOLEAN 使用房源資訊進行機器處理。僅適用於 FTP 伺服器。

在整合服務中使用 FTP 連線

建立連線後,Apigee Integration 和 Application Integration 都會提供該連線。您可以在整合中透過「連接器」工作使用連線。

  • 如要瞭解如何在 Apigee Integration 中建立及使用「連線器」工作,請參閱「連線器工作」。
  • 如要瞭解如何在 Application Integration 中建立及使用「連線器」工作,請參閱「連線器工作」。

向 Google Cloud 社群尋求協助

如要發布問題及討論這個連接器,請前往 Cloud 論壇的 Google Cloud 社群。

後續步驟