Confluence

您可以使用 Confluence 連接器,在 Confluence 中執行插入、刪除、更新和讀取作業。

事前準備

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

  • 在 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. 連接器:從可用連接器的下拉式清單中選取「Confluence」
    2. 連接器版本:從可用版本的下拉式清單中選取連接器版本。
    3. 在「連線名稱」欄位中,輸入連線執行個體的名稱。

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

      • 連線名稱可使用英文字母、數字或連字號。
      • 字母必須為小寫。
      • 連線名稱開頭須為英文字母,結尾則須為英文字母或數字。
      • 連結名稱不得超過 49 個字元。
    4. 視需要輸入連線執行個體的「Description」(說明)
    5. 或者,可啟用 Cloud Logging,然後選取記錄層級。記錄層級預設為「錯誤」。
    6. 服務帳戶:選取具備必要角色的服務帳戶。
    7. 如要將已封存聊天室的內容納入搜尋結果,請選取「包含已封存的聊天室」。預設值為 false。
    8. (選用) 輸入空間金鑰,搜尋結果只會顯示該空間的內容。
    9. 視需要設定「連線節點設定」

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

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

    10. 選用:按一下「+ 新增標籤」,以鍵/值組合的形式為連線新增標籤。
    11. 點按「下一步」
  5. 在「目的地」部分,輸入要連線的遠端主機 (後端系統) 詳細資料。
    1. 目的地類型:選取目的地類型
      • 如要指定目的地主機名稱或 IP 位址,請選取「主機地址」,然後在「主機 1」欄位中輸入地址。
      • 如要建立私人連線,請選取「Endpoint attachment」(端點連結),然後從「Endpoint Attachment」(端點連結) 清單中選擇所需連結。

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

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

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

      Confluence 連接器支援下列驗證類型:

      • 基本版
      • APIToken
      • OAuth2.0
    2. 如要瞭解如何設定這些驗證類型,請參閱「設定驗證」。

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

設定驗證機制

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

  • 基本
    • 使用者名稱:用於驗證的 Confluence 使用者帳戶。
    • 密碼:與帳戶相關聯的密碼。
  • APIToken
    • 使用者名稱:用於建立 API 權杖的 Confluence 使用者名稱。
    • API 權杖:使用者名稱的密碼是 API 權杖。選取 Secret Manager Secret,內含與 Confluence 使用者名稱相關聯的 API 權杖。
  • OAuth 2.0 - 授權碼
    • 用戶端 ID: 外部應用程式提供的用戶端 ID。
    • 範圍: 權限範圍。使用 Confluence 連接器時,必須使用 offline_access 範圍。如要進一步瞭解 Confluence 範圍,請參閱「Confluence 範圍」。
    • 用戶端密鑰: 選取 Secret Manager 密鑰。 設定這項授權前,您應該已建立 Secret Manager 密鑰。
    • 密鑰版本: 用戶端密鑰的 Secret Manager 密鑰版本。
    • 如果是 Authorization code 驗證類型,建立連線後,您必須執行幾個額外步驟來設定驗證。詳情請參閱建立連結後需執行的額外步驟

建立連結後需執行的其他步驟

如果您選取 OAuth 2.0 - Authorization code 進行驗證,建立連線後必須執行下列額外步驟:

  1. 在「連線」頁面中,找出新建立的連線。

    請注意,新連接器的「狀態」會顯示「需要授權」

  2. 按一下「需要授權」

    系統隨即會顯示「編輯授權」窗格。

  3. 將「重新導向 URI」值複製到外部應用程式。
  4. 驗證授權詳細資料。
  5. 按一下「Authorize」

    授權成功後,「連線」頁面的連線狀態會設為「有效」

重新授權授權碼

如果您使用 Authorization code 驗證類型,且已在 Confluence 應用程式中進行任何設定變更,則必須重新授權 Confluence 連線。如要重新授權連結,請按照下列步驟操作:

  1. 在「連線」頁面中,按一下所需連線。

    系統隨即會開啟連線詳細資料頁面。

  2. 按一下「編輯」即可編輯連結詳細資料。
  3. 在「驗證」部分中,確認「OAuth 2.0 - 授權碼」詳細資料。

    視需要進行必要變更。

  4. 按一下 [儲存]。系統會將您帶往連線詳細資料頁面。
  5. 在「驗證」部分中,按一下「編輯授權」。系統會顯示「Authorize」(授權) 窗格。
  6. 按一下「Authorize」

    如果授權成功,「連線」頁面的連線狀態會設為「有效」

系統限制

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

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

在整合中使用的 Confluence 連線

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

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

實體、作業和動作

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

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

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

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

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

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

動作

Confluence 連接器提供「DownloadAttachment」和「UploadAttachment」等動作。如要瞭解如何設定動作,請參閱「動作範例」。

動作範例

本節說明如何在這個連接器中執行部分動作。

範例 - 下載附件

  1. 在「Configure connector task」對話方塊中,按一下 Actions
  2. 選取 DownloadAttachment 動作,然後按一下「完成」
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入類似下列的值:
      {
        "AttachmentId": "xyz"
      }

實體作業範例

範例 - 列出所有要求

這個範例會列出 Requests 實體中的所有要求。

  1. 在「Configure connector task」對話方塊中,按一下 Entities
  2. Entity 清單中選取「要求」。
  3. 選取「LIST」作業,然後按一下「完成」

範例 - 從特定帳戶 ID 取得使用者

這個範例會從 Users 實體取得 AccountId 為 6035864ce2020c0070b5285b 的使用者。

  1. 在「Configure connector task」對話方塊中,按一下 Entities
  2. Entity 清單中選取 Users
  3. 選取「LIST」作業,然後按一下「完成」
  4. 在「Connectors」(連接器) 工作的「Task Input」(工作輸入) 區段中,按一下「filterClause」,然後在「Default Value」(預設值) 欄位中輸入 AccountId=6035864ce2020c0070b5285b

    其中 AccountIdUsers 實體的主鍵值。

範例 - 清單頁面

這個範例列出 Pages 實體的網頁。

  1. 在「Configure connector task」對話方塊中,按一下 Entities
  2. Entity 清單中選取 Pages
  3. 選取「LIST」作業,然後按一下「完成」

範例 - 取得頁面

這個範例會從 Pages 實體取得網頁記錄。

  1. 在「Configure connector task」對話方塊中,按一下 Entities
  2. Entity 清單中選取 Pages
  3. 選取「GET」作業,然後按一下「完成」
  4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下「entityId」,然後在「Default Value」(預設值) 欄位中輸入 123

    其中 123 是資源 Pages 實體的專屬 ID。

範例 - 建立頁面

這個範例會在 Pages 實體中建立網頁記錄。

  1. 在「Configure connector task」對話方塊中,按一下 Entities
  2. Entity 清單中選取 Pages
  3. 選取「CREATE」作業,然後按一下「完成」
  4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入類似下列的值:
    {
          "SpaceId": "12345",
          "Status": "Current",
          "Title": "FROM XYZ",
          "Storage": "XYZ1234"
        }
    

Example - Update Pages

This example updates a page record in the Pages entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select Pages from the Entity list.
  3. Select the UPDATE operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:
    {
        "Title": "Update abc"
        }
  5. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下「entityId」,然後在「Default Value」(預設值) 欄位中輸入 12345
  6. 如果整合成功,連接器工作的 connectorOutputPayload 欄位會顯示更新作業的回應。

    {
        "Id": 1234
        }

範例 - 刪除頁面

這個範例會從 Pages 實體刪除網頁。

  1. 在「Configure connector task」對話方塊中,按一下 Entities
  2. Entity 清單中選取 Pages
  3. 選取「DELETE」作業,然後按一下「完成」
  4. 在「連線器」工作的「工作輸入」部分,按一下「entityId」,然後在「預設值」欄位中輸入 123

    或者,如果實體具有複合式主鍵,而非指定 entityId,則可以設定 filterClause。例如:Id='123'

使用 Terraform 建立連線

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

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

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

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

參數名稱 資料類型 必填 說明
proxy_enabled BOOLEAN 選取這個核取方塊,即可為連線設定 Proxy 伺服器。
proxy_auth_scheme ENUM 用於向 ProxyServer Proxy 驗證的驗證類型。支援的值包括:BASIC、DIGEST、NONE
proxy_user STRING 用於向 ProxyServer Proxy 驗證的使用者名稱。
proxy_password SECRET 用於向 ProxyServer 代理程式驗證的密碼。
proxy_ssltype ENUM 連線至 ProxyServer Proxy 時要使用的 SSL 類型,支援的值包括:AUTO、ALWAYS、NEVER、TUNNEL

向 Google Cloud 社群尋求協助

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

後續步驟