> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kasoftware.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 配置端口

> 知行之橋中 API 端口的所有可配置屬性。

此部分包含所有可配置的端口屬性。

## 設定索引標籤

### 端口詳情

*確定如何存取 API 的設定。*

| 設定 | 說明 |
| - | - |
| **端口 Id** | 端口的靜態唯一識別碼。 |
| **端口型別** | 顯示端口名稱及其功能說明。 |
| **端口描述** | 可選欄位，用於以自由文字形式描述端口及其在工作流程中的角色。 |
| **API 介面** | 自定義 API 釋出到的 URL。要存取特定資源，請將斜槓和資源名稱附加到該 URL 值。 |
| **API 文件** | 自定義 API 文件釋出到的 URL。 |

### 連線

*與資料庫連線相關的設定。點選 **新增連線** 以配置連線。*

| 設定 | 說明 |
| - | - |
| **選擇端口** | 要連線的資料庫型別。其餘連線欄位根據資料庫選擇而變化。下面描述了最常見的欄位，但如果需要更多資訊，請檢視相應資料庫端口的文件。 |
| **伺服器** | 託管資料庫的伺服器的主機名或 IP 地址。 |
| **身分驗證方案** | 用於驗證連線的身分驗證方案型別。選擇身分驗證方案後，會顯示其他欄位。相應資料庫端口的文件包含這些欄位的詳細資訊。不適用於 DB2。 |
| **端口** | 連線到資料庫主機的端口。 |
| **資料庫** | 要連線的資料庫的名稱。 |
| **使用者** | 有權存取資料庫的使用者憑證。 |
| **密碼** | 與指定的 **使用者** 關聯的密碼憑證。 |

## 表索引標籤

**表** 索引標籤列出了端口公開的所有 API 資源。每個資源都是從連線的資料庫中存在的表或檢視生成的。新增新的表或檢視會透過端口向 Web API 呼叫公開新的資料庫資料。有關詳細資訊，請參閱 [API 資源](https://docs.kasoftware.com/26.4/self-hosted/zh-Hant/connectors/api/api-resources.md)。

## 預存程序索引標籤

**預存程序** 索引標籤列出了端口公開的所有 API 操作。每個操作都是從連線的資料庫中存在的預存程序生成的。新增新的預存程序會透過端口向 Web API 呼叫公開新的資料庫資料。有關詳細資訊，請參閱 [API 操作](https://docs.kasoftware.com/26.4/self-hosted/zh-Hant/connectors/api/api-actions.md)。

## 使用者索引標籤

**使用者** 索引標籤列出了有權對端口進行 API 呼叫的所有使用者。透過該索引標籤你可以：

* 建立使用者及其關聯的 authtoken 和 OAuth 2.0 憑證
* 定義 HTTP 方法權限（GET、POST、PUT、MERGE、PATCH 和 DELETE）
* 指定每個使用者每小時可以發出的請求數
* 指定允許的並行請求數

你可以在此索引標籤上新增、編輯和刪除使用者。有關每個欄位的詳細資訊，請參閱[使用者與身分驗證](https://docs.kasoftware.com/26.4/self-hosted/zh-Hant/connectors/api/api-authentication.md#使用者與身分驗證)。

> [!NOTE]
>
> 此處的請求設定會覆蓋 **伺服器** 索引標籤中[預設速率限制](#預設速率限制（每使用者）)部分的設定。

## 伺服器索引標籤

### 可信 IP 地址

**可信 IP 地址** 部分提供以下功能：

<table><thead><tr><th>功能</th><th>描述</th></tr></thead>
<tbody><tr><td>**新增**</td><td>輸入新的 IP 地址範圍。</td></tr>
<tr><td>**編輯**</td><td>修改選定的 IP 地址範圍。</td></tr>
<tr><td>**刪除**</td><td>從清單中刪除選定的 IP 地址範圍。</td></tr></tbody></table>

以下限制適用於此功能：

<ul><li>`localhost` 不能被修改或從清單中刪除。</li>
<li>任何超出定義範圍的 IP 地址都將被拒絕。</li>
<li>支援 IP 範圍。例如，項目 `100.10.100.1-15` 表示允許 `100.10.100.1` 和 `100.10.100.15` 之間的 IP 地址。</li>
<li>支援無類別域間路由 (CIDR) 表示法。例如，項目 `100.10.100.0/24` 表示允許 `100.10.100.0` 和 `100.10.100.255` 之間的 IP 地址。</li>
<li>支援萬用字元模式。例如，項目 `100.10.100.*` 表示允許以 `100.10.100` 開頭的 IP 地址。</li></ul>

> [!NOTE]
>
> 為了讓用戶端能夠存取伺服器，需要有清晰的網路路徑。在雲環境中，可能需要在三個地方進行更改：
>
> • 雲控制檯中的網路規則。
>
> • 託管應用程式的機器上的防火牆規則。例如，在使用 Amazon AMI 時，可以使用 *簡單防火牆*（UFW）來允許所需端口上的流量。Linux 環境中的常見策略是將流量從低於 1024 的端口轉寄到高於 1024 的非標準端口，同時將應用程式配置為使用非標準端口。這可以避免與非 root 使用者繫結到低於 1024 的端口相關的權限問題。
>
> • [安全](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/security.md) 索引標籤的 [網路存取](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/network-access.md) 部分。

### 預設速率限制（每使用者）

*限制允許的 API 請求數量的設定。*

有關更多資訊，請參閱[速率限制](https://docs.kasoftware.com/26.4/self-hosted/zh-Hant/connectors/api/api-management.md#速率限制)。

| 設定 | 說明 |
| - | - |
| **每小時最大請求數** | 單個使用者在一小時內可以發出的請求數限制。 |
| **最大並行請求** | 使用者可以發出的並行請求數限制。 |

### 跨源資源共享 (CORS)

*管理使用 CORS 來服務跨域資源的設定。*

<table><thead><tr><th>設定</th><th>描述</th></tr></thead>
<tbody><tr><td>**啟用跨源資源共享 (CORS)**</td>
<td>是否啟用 CORS。僅當選中此框時，其餘選項才可用。</td></tr>
<tr><td>**允許所有不帶 '\*' 的域**</td>
<td>如果啟用，域來源不限於特定清單。</td></tr>
<tr><td>**Access-Control-Allow-Origin**</td>
<td>要允許的以逗號分隔的域來源清單。作為 HTTP 回應訊息頭包含在內。</td></tr>
<tr><td>**Access-Control-Allow-Credentials**</td>
<td>跨域請求中是否允許使用者憑據（例如 cookie）。作為 HTTP 回應訊息頭包含在內。</td></tr>
<tr><td>**Access-Control-Allow-Methods**</td>
<td>允許的以逗號分隔的方法清單。作為 HTTP 回應訊息頭包含在內。</td></tr>
<tr><td>**Access-Control-Allow-Headers**</td>
<td>允許的訊息頭的逗號分隔清單。作為 HTTP 回應訊息頭包含在內。</td></tr>
<tr><td>**Access-Control-Max-Age**</td>
<td>可以快取 Access-Control 回應訊息頭值的最大持續時間（以秒為單位）。</td></tr></tbody></table>

### OData

*與 OData 功能支援相關的設定。*

| 設定 | 說明 |
| - | - |
| **伺服器端分頁大小** | OData 請求傳回的每頁結果數。將此選項設定為 0 以傳回所有結果。 |
| **預設格式** | 當用戶端未指定格式時要使用的 OData 格式。 |
| **預設版本** | 當用戶端未指定版本時要使用的 OData 版本。 |
| **日期時間格式** | 傳回日期時間資訊時使用的格式。 |
| **基本 URL** | OData 介面的完全限定 URL。如果未指定，知行之橋會嘗試根據傳入請求建立基本 URL。 |
| **URL 中的 Authtoken** | 勾選此項以允許端口在查詢字串參數中傳遞 authtoken 以進行身分驗證。有關更多資訊，請參閱[使用 Authtoken 作為查詢字串參數](https://docs.kasoftware.com/26.4/self-hosted/zh-Hant/connectors/api/api-authentication.md#使用-authtoken-作為查詢字串參數)。 |

## 進階選項卡

### 訊息

> [!NOTE]
>
> **儲存至 Sent 資料夾**和**Sent 資料夾方案**設定已棄用，預設處於隱藏狀態。只有先前已啟用這些設定或將其配置為非預設值的端口才會顯示它們。若要保留成功處理的檔案副本，請在工作流程中右鍵單擊該端口，選擇**顯示成功路徑**，然後將成功路徑連線到[File 端口](https://docs.kasoftware.com/26.4/self-hosted/zh-Hant/connectors/file.md)。

| 設定 | 描述 |
| - | - |
| **儲存至 Sent 資料夾**（已棄用） | 將端口處理的檔案複製到 Sent 資料夾。預設停用。儲存到 Sent 資料夾中的檔案不受靜態加密保護。 |
| **Sent 資料夾方案**（已棄用） | 按所選時間間隔對 Sent 資料夾中的檔案進行分組。僅在啟用**儲存至 Sent 資料夾**時適用。 |

### 日誌

| 設定 | 說明 |
| - | - |
| **日誌級別** | 端口生成日誌的詳細程度。請求支援時，請將其設定為 **Debug**。 |
| **日誌子資料夾方案** | 指示端口根據所選間隔對 Logs 資料夾中的檔案進行分組。**每週** 選項（預設值）指示端口每週建立一個新的子資料夾，並將該周的所有日誌儲存在該資料夾中。將此設定留空表示端口將所有日誌直接儲存到 Logs 資料夾中。對於處理大量交易的端口，使用子資料夾有助於保持日誌有序並提升效能。 |
| **日誌訊息** | 勾選此項可使已處理檔案的日誌項目包含檔案本身的副本。如果停用此功能，可能無法從 **交易** 索引標籤下載檔案副本。 |

### 其他

*其他設定用於特定用例。*

| 設定 | 說明 |
| - | - |
| **其他設定** | 允許你以分號分隔的清單配置隱藏端口設定（例如 `setting1=value1;setting2=value2`）。正常的端口用例和功能不應需要使用這些設定。 |

## 警示索引標籤

*與配置警示相關的設定。*

在執行服務級別協議 (SLA) 之前，需要設定用於通知的電子郵件警示。預設情況下，知行之橋使用[警示](https://docs.kasoftware.com/26.4/self-hosted/zh-Hant/getting-started/administration/settings/settings-page.md#通知)索引標籤上的全域設定。要對此端口使用其他設定，請開啟 **覆蓋全域設定**。

預設情況下，錯誤警示處於啟用狀態，這意味著每當發生錯誤時都會傳送電子郵件。要將其關閉，請取消選中 **啟用** 核取方塊。

輸入 **主題**（必填），然後可選擇輸入以逗號分隔的 **收件人** 電子郵件清單。

## SLA 索引標籤

*與配置服務級別協議 (SLA) 相關的設定。*

SLA 允許你配置工作流程中的端口預期傳送或接收的數量，並設定期望滿足該數量的時間範圍。當 SLA 未滿足時，知行之橋會傳送電子郵件提醒使用者，並將 SLA 標記為 *At Risk*，這意味著如果 SLA 很快仍未滿足，它將被標記為 *Violated*。這讓使用者有機會介入並確定 SLA 未滿足的原因，並採取適當措施。如果在風險期結束時 SLA 仍未滿足，則 SLA 會被標記為違反，並再次通知使用者。

要定義 SLA，請開啟 **預期數量**，然後點選 **設定** 索引標籤。

* 如果端口具有單獨的傳送和接收操作，請使用選項按鈕指定 SLA 適用於哪個方向。
* 在視窗的 **Expect at least** 部分：
  * 設定你期望處理的最小交易數（數量）
  * 使用 **Every** 欄位指定時間範圍
  * 指定 SLA 應何時生效。如果選擇 **Starting on**，請填寫日期和時間欄位。
  * 選中希望 SLA 生效的星期幾。必要時使用下拉式清單選擇 **Everyday**。
* 在視窗的 **Set status to 'At Risk'** 部分，指定 SLA 應何時標記為存在風險。
  * 預設情況下，只有當 SLA 違反時才傳送通知。要更改此設定，請勾選 **Send an 'At Risk' notification**。

> [!NOTE]
>
> 如有必要，可以關閉 SLA 警示。這在維護時段可能很有用。點選導覽列上的 **設定**，然後導航到 **警示 > 常規警示**。點選平板和鉛筆圖示進行編輯，並取消勾選 **SLA 警示** 設定。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.