本頁面由 Cloud Translation API 翻譯而成。

Jira Cloud

Jira Cloud 連接器可讓您對以資料庫形式建立的 Jira 資料執行插入、刪除、更新和讀取作業。

支援的版本

Jira Cloud 連接器會使用 JIRA Cloud REST API 的第 2 版和第 3 版。這些設定會在內部管理，您不需要進行任何額外設定。

事前準備

使用 Jira Cloud 連接器前，請先完成下列工作：

在 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)
  如要瞭解如何啟用服務，請參閱「啟用服務」。
如果專案先前未啟用這些服務或權限，系統會在設定連結器時提示您啟用。

設定連接器

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

在 Cloud 控制台中，前往「Integration Connectors」>「Connections」頁面，然後選取或建立 Google Cloud 專案。
前往「連線」頁面
按一下「+ 建立新連線」，開啟「建立連線」頁面。
在「位置」部分中，選擇連線位置。
1. 區域：從下拉式清單中選取位置。
  如需所有支援的地區清單，請參閱「位置」一文。
2. 點按「下一步」。
在「連線詳細資料」部分，完成下列步驟：
1. 連結器：從可用連結器的下拉式清單中選取「Jira Cloud」。
2. 連接器版本：從可用版本的下拉式清單中選取連接器版本。
3. 在「連線名稱」欄位中，輸入連線執行個體的名稱。
  連線名稱必須符合下列條件：
  - 連線名稱可使用英文字母、數字或連字號。
  - 字母必須為小寫。
  - 連線名稱開頭須為英文字母，結尾則須為英文字母或數字。
  - 連結名稱不得超過 49 個字元。
  - 如果連接器支援事件訂閱，連接名稱開頭不得為「goog」前置字串。
4. 視需要輸入連線執行個體的「Description」(說明)。
5. 或者，可啟用 Cloud Logging，然後選取記錄層級。記錄層級預設為 Error。
6. 服務帳戶：選取具備必要角色的服務帳戶。
7. 如要將連線用於事件訂閱，請選取「啟用事件訂閱」。選取這個選項後，會顯示下列選項：
  - 啟用事件訂閱功能，並使用實體和動作：選取這個選項，即可將連線用於事件訂閱和連接器作業 (實體和動作)。
  - 只啟用事件訂閱項目：選取這個選項，即可只將連線用於事件訂閱。如果選取這個選項，請按一下「下一步」，然後設定事件訂閱。
8. 視需要設定「連線節點設定」：
  - 節點數量下限：輸入連線節點數量下限。
  - 節點數量上限：輸入連線節點數量上限。
  節點是用來處理交易的連線單位 (或備用資源)。連線處理的交易量越多，就需要越多節點；反之，處理的交易量越少，需要的節點就越少。如要瞭解節點對連接器定價的影響，請參閱「連線節點定價」。如未輸入任何值，系統預設會將節點下限設為 2 (提高可用性)，節點上限則設為 50。
9. (選用) 在「進階設定」部分，選取「使用 Proxy」核取方塊，為連線設定 Proxy 伺服器，並設定下列值：
10. 選用：按一下「+ 新增標籤」，以鍵/值組合的形式為連線新增標籤。
11. 點按「下一步」。
在「目的地」部分，輸入要連線的遠端主機 (後端系統) 詳細資料。
1. 目的地類型：選取目的地類型。
  - 主機位址：指定目的地的主機名稱或 IP 位址。
    注意：如要指定主機名稱，請務必一併指定網址和通訊協定 (HTTP 或 HTTPS)。
    
    如要建立與後端的私人連線，請按照下列步驟操作：
    - 建立 PSC 服務連結。
    - 建立端點連結，然後在「主機地址」欄位中輸入端點連結的詳細資料。
  如要輸入其他目的地，請按一下「+新增目的地」。
2. 點按「下一步」。
在「Authentication」(驗證) 部分中，輸入驗證詳細資料。
1. 選取「驗證類型」並輸入相關詳細資料。
  Jira Cloud 連線支援下列驗證類型：
  - 使用者名稱和密碼
2. 點按「下一步」。
如果已啟用事件訂閱功能，連線建立頁面會顯示「事件訂閱詳細資料」部分。如要瞭解如何設定事件訂閱詳細資料，請參閱「設定事件訂閱」。
檢查：檢查連線和驗證詳細資料。
點選「建立」。

設定事件訂閱

如果您已啟用事件訂閱功能，請在「Event Subscription Details」(事件訂閱詳細資料) 區段中輸入下列值：

選取「目的地類型」。
- 主機位址：在「host」欄位中輸入後端系統的註冊網址。
輸入驗證詳細資料。
1. 使用者名稱：輸入使用者名稱。
2. API 權杖：選取內含 API 權杖的 Secret Manager 密鑰。
3. 密鑰版本：選取密鑰版本。
選取「啟用私人連線」，在後端應用程式和連線之間建立安全連線。如果選取這個選項，您必須在建立連線後執行額外設定步驟。詳情請參閱「活動訂閱的私人連線」。
輸入無法傳送郵件的設定。如果設定無效信件，連線會將未處理的事件寫入指定的 Pub/Sub 主題。輸入下列詳細資料：
1. 無法傳送的訊息專案 ID： 您已設定無法傳送的訊息 Pub/Sub 主題的 Google Cloud 專案 ID。
2. 無效信件主題： 要寫入未處理事件詳細資料的 Pub/Sub 主題。
如要使用 Proxy 連線至後端 (用於事件訂閱)，請輸入下列詳細資料：

Proxy SSL Type：連線至 Proxy 伺服器時要使用的 SSL 類型。選取下列任一驗證類型：
- 一律：事件訂閱的連線一律啟用 SSL。
- 永不：連線未啟用 SSL，無法訂閱事件。
Proxy 驗證機制：選取要用來向 Proxy 伺服器驗證身分的驗證類型。系統支援下列驗證類型：
- 基本：基本 HTTP 驗證。
Proxy 使用者：輸入要用於向 Proxy 伺服器驗證的使用者名稱。
Proxy Password：選取使用者密碼的 Secret Manager 密鑰。
密鑰版本：選取密鑰版本。
在「Proxy 伺服器」部分中，輸入 Proxy 伺服器的詳細資料。
1. 按一下「+ 新增目的地」，然後選取「目的地類型」為「主機地址」。
2. 輸入 Proxy 伺服器的主機名稱或 IP 位址，以及 Proxy 伺服器的通訊埠號碼。

設定驗證機制

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

使用者名稱和密碼
- 使用者名稱：用於連線的 Jira Cloud 使用者名稱。
- API 權杖：使用者名稱的密碼是 API 權杖。選取包含與 Jira Cloud 使用者名稱相關聯 API 權杖的 Secret Manager Secret。
OAuth 2.0 - 授權碼

用戶端 ID： 外部應用程式提供的用戶端 ID。
範圍： 權限範圍。如要建立連線，必須使用 offline_access 和 read:jira-user 範圍。如要瞭解範圍的運作方式，並查看 Jira Cloud 的所有可用範圍，請參閱「範圍」。
用戶端密鑰： 選取 Secret Manager 密鑰。設定這項授權前，您應該已建立 Secret Manager 密鑰。
密鑰版本： 用戶端密鑰的 Secret Manager 密鑰版本。
Cloud ID：指定 Atlassian 網站的 Cloud ID。如要瞭解如何取得 Cloud ID，請參閱「Cloud ID」。

如果是 Authorization code 驗證類型，建立連線後，您應執行幾個額外步驟來設定驗證。詳情請參閱建立連結後需執行的額外步驟。

注意：如果您使用 Authorization code 驗證類型，且已在 Jira Cloud 應用程式中進行任何設定變更，則必須重新授權 Jira Cloud 連線。如要瞭解如何重新授權，請參閱「授權碼重新授權」。

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

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

在「連線」頁面中，找出新建立的連線。
請注意，新連接器的「狀態」會顯示「需要授權」。
按一下「需要授權」。
系統隨即會顯示「編輯授權」窗格。
將「重新導向 URI」值複製到外部應用程式。
驗證授權詳細資料。
按一下「Authorize」。
授權成功後，「連線」頁面的連線狀態會設為「有效」。

重新授權授權碼

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

在「連線」頁面中，按一下所需連線。
系統隨即會開啟連線詳細資料頁面。
按一下「編輯」即可編輯連結詳細資料。
在「驗證」部分中，確認「OAuth 2.0 - 授權碼」詳細資料。
視需要進行必要變更。
按一下 [儲存]。系統會將您帶往連線詳細資料頁面。
在「驗證」部分中，按一下「編輯授權」。系統會顯示「Authorize」(授權) 窗格。
按一下「Authorize」。
如果授權成功，「連線」頁面的連線狀態會設為「有效」。

系統限制

Jira Cloud 連接器每個節點每秒最多可處理 10 筆交易，超過此限制的交易都會遭到節流。根據預設，Integration Connectors 會為連線分配 2 個節點 (以提高可用性)。

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

實體作業範例

本節說明如何使用這個連接器執行部分實體作業。

範例 - 清單問題

在「Configure connector task」對話方塊中，按一下 Entities。
從 Entity 清單中選取「問題」。
選取「LIST」作業，然後按一下「完成」。
在「連線器」工作的「工作輸入」部分，您可以根據客戶需求設定 filterClause。

您必須使用單引號 (') 將 filterClause 的值括起來，例如 CreatorEmail = 'cruz@altostrat.com'。您可以使用 filterClause，根據資料欄篩選記錄。

在某些實體中，只有「列出」作業無法擷取資料。在這種實體中，您可以使用 filetClause。

範例 - 取得問題

在「Configure connector task」對話方塊中，按一下 Entities。
從 Entity 清單中選取「問題」。
選取「GET」作業，然後按一下「完成」。
將實體 ID 設為 10000，這是要傳遞給問題的 ID。如要設定實體 ID，請在「Connectors」(連結器) 任務的「Task Input」(工作輸入) 部分中，按一下「EntityId」(實體 ID)，然後在「Default Value」(預設值) 欄位中輸入 10000。

實體 ID 的值必須直接傳遞，例如 10000。其中 10000 是不重複的主鍵值。 Get 作業只能對具有唯一主鍵的實體執行。

範例 - 刪除問題

在「Configure connector task」對話方塊中，按一下 Entities。
從 Entity 清單中選取「問題」。
選取「DELETE」作業，然後按一下「完成」。
將實體 ID 設為 10000，也就是要傳遞的鍵。如要設定實體 ID，請在「Connectors」(連結器) 任務的「Task Input」(工作輸入) 部分中，按一下「EntityId」(實體 ID)，然後在「Default Value」(預設值) 欄位中輸入 10000。

只有具有專屬主鍵的實體才能執行刪除作業。

範例 - 建立 IssueType

在「Configure connector task」對話方塊中，按一下 Entities。
從 Entity 清單中選取 IssueTypes。
選取「Create」作業，然後按一下「完成」。
在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
```
{
  "Name": "task123456",
  "Description": "New description is added."
}
```
如果整合成功，連接器工作 connectorOutputPayload 回應參數的值會類似於下列內容：
```
{
  "Id": "10041"
}
```

範例 - 建立問題

在「Configure connector task」對話方塊中，按一下 Entities。
從 Entity 清單中選取「問題」。
選取「Create」作業，然後按一下「完成」。
在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
```
  {
    "IssueTypeName": "Subtask", 
    "ProjectName": "kanban4", 
    "Summary": "Summary Added", 
    "ParentKey": "KN-6" 
  }
```
如果整合成功，連接器工作 connectorOutputPayload 回應參數的值會類似於下列內容：
```
{
  "Id": 10071.0
}
```

範例 - 建立衝刺

在「Configure connector task」對話方塊中，按一下 Entities。
從 Entity 清單中選取「衝刺」。
選取「Create」作業，然後按一下「完成」。
在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
```
{
  "Name": "PROJ Sprint GCPcloud",
  "State": "future",
  "Goal": null,
  "OriginBoardId": 2.0,
  "StartDate": "2023-06-27 07:06:08",
  "EndDate": "2023-07-27 07:06:08"
}
```
如果整合成功，連接器工作 connectorOutputPayload 回應參數的值會類似於下列內容：
```
{
  "Id": 23.0
}
```

範例 - 建立留言

在「Configure connector task」對話方塊中，按一下 Entities。
從 Entity 清單中選取「留言」。
選取「Create」作業，然後按一下「完成」。
在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
```
{
  "IssueId": 10001.0,
  "Body": "Adding comments to above ID by editing it"
}
```
如果整合成功，連接器工作 connectorOutputPayload 回應參數的值會類似於下列內容：
```
{
  "Id": 10023.0,
  "IssueId": null
}
```

範例 - 建立使用者

在「Configure connector task」對話方塊中，按一下 Entities。
從 Entity 清單中選取「使用者」。
選取「Create」作業，然後按一下「完成」。
在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
```
{
  "GroupName": null,
  "DisplayName": "Charlie",
  "EmailAddress": "charlie@altostrat.com",
  "Active": true,
  "TimeZone": null,
  "Locale": "en_US",
  "AccountType": "atlassian"
}
```
如果整合成功，連接器工作 connectorOutputPayload 回應參數的值會類似於下列內容：
```
{
  "AccountId": "557058:0a04612c-746d-4d47-a909-71ba797fe228"
}
```

範例 - 建立工作記錄

在「Configure connector task」對話方塊中，按一下 Entities。
從 Entity 清單中選取「工作記錄」。
選取「Create」作業，然後按一下「完成」。
在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
```
{
  "IssueKey": "GJCT-1",
  "Started": "2023-06-10 08:08:08",
  "TimeSpent": "2000"
}
```
如果整合成功，連接器工作 connectorOutputPayload 回應參數的值會類似於下列內容：
```
{
  "Id": "41718",
  "IssueId": 10000.0
}
```

範例 - 更新問題類型

在「Configure connector task」對話方塊中，按一下 Entities。
從 Entity 清單中選取 IssueTypes。
選取「Update」作業，然後按一下「完成」。
在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
```
{
  "Name": "NEW_TASK",
  "Description": "New Description"
}
```
將實體 ID 設為 IssueTypes 的實體。如要設定實體 ID，請按一下 entityId，然後在「Default Value」(預設值) 欄位中輸入 10038。
如果整合成功，連接器工作 connectorOutputPayload 回應參數的值會類似於下列內容：
```
{
  "Id": "10038"
}
```

範例 - 更新問題

在「Configure connector task」對話方塊中，按一下 Entities。
從 Entity 清單中選取「問題」。
選取「Update」作業，然後按一下「完成」。
在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
```
{
  "AssigneeAccountId": "61d572aa7c6f9800705289a1",
  "AssigneeName": "Charlie c"
}
```
將實體 ID 設為問題的實體。如要設定實體 ID，請按一下 entityId，然後在「Default Value」(預設值) 欄位中輸入 10024。
如果整合成功，連接器工作 connectorOutputPayload 回應參數的值會類似於下列內容：
```
{
  "AssigneeDisplayName": "Charlie Cruz"
}
```

範例 - 更新衝刺

在「Configure connector task」對話方塊中，按一下 Entities。
從 Entity 清單中選取「衝刺」。
選取「Update」作業，然後按一下「完成」。
在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
```
{
  "Name": "PROJ Sprint GCP_Updated",
  "State": "future",
  "StartDate": "2023-06-27 07:06:08",
  "EndDate": "2023-07-27 07:06:08"
} 
```
將實體 ID 設為 Sprint 的實體。如要設定實體 ID，請按一下 entityId，然後在「Default Value」(預設值) 欄位中輸入 2 。
如果整合成功，連接器工作 connectorOutputPayload 回應參數的值會類似於下列內容：
```
{
}
```

範例 - 更新留言

在「Configure connector task」對話方塊中，按一下 Entities。
從 Entity 清單中選取「留言」。
選取「Update」作業，然後按一下「完成」。
在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
```
{
  "Name": "PROJ Sprint GCPcloud_Updated",
  "State": "future",
  "StartDate": "2023-06-27 07:06:08",
  "EndDate": "2023-07-27 07:06:08"
} 
```
將實體 ID 設為留言的實體。如要設定實體 ID，請按一下 entityId，然後在「Default Value」(預設值) 欄位中輸入 2。
如果整合成功，連接器工作 connectorOutputPayload 回應參數的值會類似於下列內容：
```
{
}
```

使用 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

在整合中建立 Jira Cloud 連線

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

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

向 Google Cloud 社群尋求協助

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

後續步驟

瞭解如何暫停及恢復連線。
瞭解如何監控連結器用量。
瞭解如何查看連接器記錄。