> ## 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 端口的所有可配置属性。

export const CommonCors = () => <>
    <table>
      <thead>
        <tr><th>设置</th><th>描述</th></tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>启用跨源资源共享 (CORS)</strong></td>
          <td>是否启用 CORS。仅当选中此框时，其余选项才可用。</td>
        </tr>
        <tr>
          <td><strong>允许所有不带 '*' 的域</strong></td>
          <td>如果启用，域来源不限于特定列表。</td>
        </tr>
        <tr>
          <td><strong>Access-Control-Allow-Origin</strong></td>
          <td>要允许的以逗号分隔的域来源列表。作为 HTTP 响应消息头包含在内。</td>
        </tr>
        <tr>
          <td><strong>Access-Control-Allow-Credentials</strong></td>
          <td>跨域请求中是否允许用户凭据（例如 cookie）。作为 HTTP 响应消息头包含在内。</td>
        </tr>
        <tr>
          <td><strong>Access-Control-Allow-Methods</strong></td>
          <td>允许的以逗号分隔的方法列表。作为 HTTP 响应消息头包含在内。</td>
        </tr>
        <tr>
          <td><strong>Access-Control-Allow-Headers</strong></td>
          <td>允许的消息头的逗号分隔列表。作为 HTTP 响应消息头包含在内。</td>
        </tr>
        <tr>
          <td><strong>Access-Control-Max-Age</strong></td>
          <td>可以缓存 Access-Control 响应消息头值的最大持续时间（以秒为单位）。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const TrustedIp = () => <>
    <p><strong>可信 IP 地址</strong> 部分提供以下功能：</p>

    <table>
      <thead>
        <tr><th>功能</th><th>描述</th></tr>
      </thead>
      <tbody>
        <tr><td><strong>添加</strong></td><td>输入新的 IP 地址范围。</td></tr>
        <tr><td><strong>编辑</strong></td><td>修改选定的 IP 地址范围。</td></tr>
        <tr><td><strong>删除</strong></td><td>从列表中删除选定的 IP 地址范围。</td></tr>
      </tbody>
    </table>

    <p>以下限制适用于此功能：</p>

    <ul style={{
  listStyleType: 'disc',
  paddingLeft: '1.5rem'
}}>
      <li style={{
  display: 'list-item'
}}><code>localhost</code> 不能被修改或从列表中删除。</li>
      <li style={{
  display: 'list-item'
}}>任何超出定义范围的 IP 地址都将被拒绝。</li>
      <li style={{
  display: 'list-item'
}}>支持 IP 范围。例如，条目 <code>100.10.100.1-15</code> 表示允许 <code>100.10.100.1</code> 和 <code>100.10.100.15</code> 之间的 IP 地址。</li>
      <li style={{
  display: 'list-item'
}}>支持无类别域间路由 (CIDR) 表示法。例如，条目 <code>100.10.100.0/24</code> 表示允许 <code>100.10.100.0</code> 和 <code>100.10.100.255</code> 之间的 IP 地址。</li>
      <li style={{
  display: 'list-item'
}}>支持通配符模式。例如，条目 <code>100.10.100.*</code> 表示允许以 <code>100.10.100</code> 开头的 IP 地址。</li>
    </ul>

    <Note>
      <p>为了让客户端能够访问服务器，需要有清晰的网络路径。在云环境中，可能需要在三个地方进行更改：</p>
      <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>• 云控制台中的网络规则。</p>
      <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>• 托管应用程序的机器上的防火墙规则。例如，在使用 Amazon AMI 时，可以使用 <em>简单防火墙</em>（UFW）来允许所需端口上的流量。Linux 环境中的常见策略是将流量从低于 1024 的端口转发到高于 1024 的非标准端口，同时将应用程序配置为使用非标准端口。这可以避免与非 root 用户绑定到低于 1024 的端口相关的权限问题。</p>
      <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>• <a href="/26.2/self-hosted/zh/getting-started/administration/settings/security">安全</a> 选项卡的 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/network-access">网络访问</a> 部分。</p>
    </Note>
  </>;

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

## 设置选项卡

### 端口详情

*确定如何访问 API 的设置。*

| 设置         | 说明                                            |
| ---------- | --------------------------------------------- |
| **端口 Id**  | 端口的静态唯一标识符。                                   |
| **端口类型**   | 显示端口名称及其功能说明。                                 |
| **端口描述**   | 可选字段，用于以自由文本形式描述端口及其在工作流中的角色。                 |
| **API 接口** | 自定义 API 发布到的 URL。要访问特定资源，请将斜杠和资源名称附加到该 URL 值。 |
| **API 文档** | 自定义 API 文档发布到的 URL。                           |

### 连接

*与数据库连接相关的设置。点击 **添加连接** 以配置连接。*

| 设置         | 说明                                                                |
| ---------- | ----------------------------------------------------------------- |
| **选择端口**   | 要连接的数据库类型。其余连接字段根据数据库选择而变化。下面描述了最常见的字段，但如果需要更多信息，请查看相应数据库端口的文档。   |
| **服务器**    | 托管数据库的服务器的主机名或 IP 地址。                                             |
| **身份验证方案** | 用于验证连接的身份验证方案类型。选择身份验证方案后，会显示其他字段。相应数据库端口的文档包含这些字段的详细信息。不适用于 DB2。 |
| **端口**     | 连接到数据库主机的端口。                                                      |
| **数据库**    | 要连接的数据库的名称。                                                       |
| **用户**     | 有权访问数据库的用户凭证。                                                     |
| **密码**     | 与指定的 **用户** 关联的密码凭证。                                              |

## 表选项卡

**表** 选项卡列出了端口公开的所有 API 资源。每个资源都是从连接的数据库中存在的表或视图生成的。添加新的表或视图会通过端口向 Web API 调用公开新的数据库数据。有关详细信息，请参阅 [API 资源](./api-resources)。

## 存储过程选项卡

**存储过程** 选项卡列出了端口公开的所有 API 操作。每个操作都是从连接的数据库中存在的存储过程生成的。添加新的存储过程会通过端口向 Web API 调用公开新的数据库数据。有关详细信息，请参阅 [API 操作](./api-actions)。

## 用户选项卡

**用户** 选项卡列出了有权对端口进行 API 调用的所有用户。通过该选项卡你可以：

* 创建用户及其关联的 authtoken 和 OAuth 2.0 凭证
* 定义 HTTP 方法权限（GET、POST、PUT、MERGE、PATCH 和 DELETE）
* 指定每个用户每小时可以发出的请求数
* 指定允许的并发请求数

你可以在此选项卡上添加、编辑和删除用户。有关每个字段的详细信息，请参阅[用户与身份验证](./api-authentication#users-and-authentication)。

<Note>
  此处的请求设置会覆盖 **服务器** 选项卡中[默认速率限制](#默认速率限制每用户)部分的设置。
</Note>

## 服务器选项卡

### 可信 IP 地址

<TrustedIp />

### 默认速率限制（每用户）

*限制允许的 API 请求数量的设置。*

有关更多信息，请参阅[速率限制](./api-management#rate-limiting)。

| 设置           | 说明                   |
| ------------ | -------------------- |
| **每小时最大请求数** | 单个用户在一小时内可以发出的请求数限制。 |
| **最大并发请求**   | 用户可以发出的并发请求数限制。      |

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

*管理使用 CORS 来服务跨域资源的设置。*

<CommonCors />

### OData

*与 OData 功能支持相关的设置。*

| 设置                   | 说明                                                                                                                                           |
| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| **服务器端分页大小**         | OData 请求返回的每页结果数。将此选项设置为 0 以返回所有结果。                                                                                                          |
| **默认格式**             | 当客户端未指定格式时要使用的 OData 格式。                                                                                                                     |
| **默认版本**             | 当客户端未指定版本时要使用的 OData 版本。                                                                                                                     |
| **日期时间格式**           | 返回日期时间信息时使用的格式。                                                                                                                              |
| **基本 URL**           | OData 接口的完全限定 URL。如果未指定，知行之桥会尝试根据传入请求创建基本 URL。                                                                                               |
| **URL 中的 Authtoken** | 勾选此项以允许端口在查询字符串参数中传递 authtoken 以进行身份验证。有关更多信息，请参阅[使用 Authtoken 作为查询字符串参数](./api-authentication#using-authtokens-as-query-string-parameters)。 |

## 高级选项卡

### 消息

| 设置            | 说明                                                                                                                                         |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| **保存到已发送文件夹** | 勾选此项可将端口处理的文件复制到该端口的 Sent 文件夹。                                                                                                             |
| **已发送文件夹方案**  | 指示端口根据所选间隔对 Sent 文件夹中的消息进行分组。例如，**每周** 选项指示端口每周创建一个新的子文件夹，并将该周的所有消息存储在该文件夹中。空白设置表示端口将所有消息直接保存到 Sent 文件夹中。对于处理大量消息的端口，使用子文件夹有助于保持消息有序并提升性能。 |

### 日志

| 设置           | 说明                                                                                                                                             |
| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| **日志级别**     | 端口生成日志的详细程度。请求支持时，请将其设置为 **Debug**。                                                                                                            |
| **日志子文件夹方案** | 指示端口根据所选间隔对 Logs 文件夹中的文件进行分组。**每周** 选项（默认值）指示端口每周创建一个新的子文件夹，并将该周的所有日志存储在该文件夹中。将此设置留空表示端口将所有日志直接保存到 Logs 文件夹中。对于处理大量交易的端口，使用子文件夹有助于保持日志有序并提升性能。 |
| **日志消息**     | 勾选此项可使已处理文件的日志条目包含文件本身的副本。如果禁用此功能，可能无法从 **交易** 选项卡下载文件副本。                                                                                      |

### 其他

*其他设置用于特定用例。*

| 设置       | 说明                                                                              |
| -------- | ------------------------------------------------------------------------------- |
| **其他设置** | 允许你以分号分隔的列表配置隐藏端口设置（例如 `setting1=value1;setting2=value2`）。正常的端口用例和功能不应需要使用这些设置。 |

## 警报选项卡

*与配置警报相关的设置。*

在执行服务级别协议 (SLA) 之前，需要设置用于通知的电子邮件警报。默认情况下，知行之桥使用[警报](../../getting-started/administration/settings/settings-page#alerts)选项卡上的全局设置。要对此端口使用其他设置，请开启 **覆盖全局设置**。

默认情况下，错误警报处于启用状态，这意味着每当发生错误时都会发送电子邮件。要将其关闭，请取消选中 **启用** 复选框。

输入 **主题**（必填），然后可选择输入以逗号分隔的 **收件人** 电子邮件列表。

## 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 警报** 设置。
</Note>
