Version 24.3.9111

• 端口选项卡
  • 端口详情
  • 连接
  • 高级设置
• Resources 选项卡
• Actions 选项卡
• 通知
  • 端口邮件设置
  • 服务等级协议 (SLA) 配置
• 用户选项卡
• 服务器选项卡
  • 可信IP地址
  • 默认速率限制（每用户）
  • 跨源资源共享（CORS）
  • OData
  • 高级设置
  • 消息
  • 日志
    • 特殊设置

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

端口选项卡

端口详情

确定如何访问 API 的设置。

• 端口 Id 端口的静态、唯一标识符。
• 端口类型 显示端口类型及其用途的描述。
• 端口描述 一个可选字段，用于提供端口及其在流中的角色的自由格式描述。
• API 接口 自定义 API 发布到的 URL。 要访问特定资源，请将斜杠和资源名称附加到该 URL 值。
• API 文档 自定义 API 文档发布到的 URL。

连接

与数据库连接相关的设置.

• 数据源类型 要连接的数据库类型。
• 设置格式 是否指定一组单独的连接属性或包含每个属性的单个连接字符串。
• 连接字符串 连接字符串格式的数据库凭据。 仅当设置格式设置为 连接字符串 时适用。
• 服务器 托管数据库的服务器的主机名或 IP 地址。
• 端口 连接到数据库主机的端口。
• 数据库 要连接的数据库的名称。
• 用户 有权访问数据库的用户凭证。
• 密码 与指定的 用户 关联的密码凭证。

高级设置

高级设置是根据配置的数据源类型自动生成的。 有关高级设置的更多信息，请参阅与的数据源匹配的端口的文档。

Resources 选项卡

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

Actions 选项卡

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

通知

与配置警报和服务等级协议 (SLA) 相关的设置。

端口邮件设置

在执行 SLA 之前，需要设置电子邮件警报以获取通知。 单击 配置通知 将打开一个新的浏览器窗口，转到 系统设置，可以在其中设置系统范围的警报。 有关详细信息，请参阅通知。

服务等级协议 (SLA) 配置

SLA 能够配置期望工作流中的端口发送或接收的数量，并设置期望满足该数量的时间范围。 知行之桥在不满足 SLA 时发送电子邮件警告用户，并将 SLA 标记为 有风险，这意味着如果很快不满足 SLA，则会将其标记为 已违反。 这使用户有机会介入并确定未满足 SLA 的原因，并采取适当的措施。 如果在风险时间段结束时仍未满足 SLA，则将 SLA 标记为违反，并再次通知用户。

要定义 SLA，请单击 添加预期数量条件。

• 如果端口具有单独的发送和接收操作，请使用单选按钮指定 SLA 所属的方向。
• 将 期待至少 设置为期望处理的最小交易数量（交易量），然后使用 每 字段指定时间范围。
• 默认情况下，SLA 每天都有效。 要更改此设置，请取消选中每日，然后选中想要的一周中的几天的框。
• 使用 将状态设置为“有风险” 来指示何时应将 SLA 标记为存在风险。
• 默认情况下，在违反 SLA 之前不会发送通知。 要更改此设置，请选中 发送“有风险”通知。

以下示例显示为预计周一至周五每天接收 1000 个文件的端口配置的 SLA。 如果尚未收到 1000 个文件，则会在该时间段结束前 1 小时发送风险通知。

用户选项卡

用户 选项卡列出了有权对端口进行 API 调用的所有用户。 可以通过 HTTP 方法（GET、POST 等）、每小时请求数以及并发请求数来限制用户。 还可以在 服务器 选项卡上按服务器管理 API 凭据。 有关详细信息，请参阅用户。

服务器选项卡

可信IP地址

此选项卡上的 可信 IP 地址 部分提供以下功能：

• 添加 输入新的 IP 地址范围。
• 编辑 修改选定的 IP 地址范围。
• 删除 从列表中删除选定的 IP 地址范围。

以下限制适用于此功能：

• localhost 不能被修改或从列表中删除。
• 任何超出定义范围的 IP 地址都将被拒绝。
• 支持IP范围。 例如，“100.10.100.1-15”条目表示允许100.10.100.1至100.10.100.15之间的IP地址访问。
• 支持 无类别域间路由(CIDR) 表示法。 例如，“100.10.100.0/24”条目表示允许100.10.100.0至100.10.100.255之间的IP地址访问。
• 支持通配符模式。 例如，条目 100.10.100.* 表示允许以 100.10.100 开头的 IP 地址。 任何超出该范围的 IP 地址都将被拒绝。

注意：为了让客户端能够访问服务器，需要有清晰的网络路径。在云环境中，可能需要在三个地方进行更改：

• 云控制台中的网络规则。
• 托管应用程序的机器上的防火墙规则。例如，在使用 Amazon AMI 时，可以使用 简单防火墙 (UFW) 来允许所需端口上的流量。Linux 环境中的常见策略是将流量从低于 1024 的端口转发到高于 1024 的非标准端口，同时将应用程序配置为使用非标准端口。这可以避免与非 root 用户绑定到低于 1024 的端口相关的权限问题。
• 系统设置 页面的 受信任的 IP 地址 部分。

默认速率限制（每用户）

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

有关更多信息，请参阅速率限制。

• 每小时最大请求数 单个用户在一小时内可以发出的请求数的限制。

• 最大并发请求 用户可以发出的并发请求数的限制。

• 跨源资源共享（CORS）

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

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

OData

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

• 服务器端分页大小 OData 请求返回的每页结果数。 将此选项设置为 0 以返回所有结果。
• 默认格式 当客户端未指定格式时要使用的 OData 格式。
• 默认版本 当客户端未指定版本时要使用的 OData 版本。
• 日期时间格式 返回日期时间信息时使用的格式。
• 基本 URL OData 接口的完全限定 URL。 如果未指定，知行之桥会尝试根据传入请求创建基本 URL。

高级设置

• URL 中的 Authtoken 选中此项以允许端口在查询字符串参数中传递身份验证令牌以进行身份验证。 有关更多信息，请参阅使用身份验证令牌作为查询字符串参数。

消息

• 保存至 Sent 文件夹 选中此选项可将端口处理的文件复制到端口的已发送文件夹中。
• 已发送文件夹方案 指示端口根据选定的时间间隔对已发送文件夹中的消息进行分组。 例如，Weekly 选项指示端口每周创建一个新的子文件夹，并将该周的所有消息存储在该文件夹中。 空白设置告诉端口将所有消息直接保存在“已发送”文件夹中。 对于处理许多消息的端口，使用子文件夹有助于保持消息的组织性并提高性能。

日志

• 日志级别 端口生成的日志的详细程度。 当请求支持时，请将其设置为 调试。
• 日志子文件夹方案 指端口根据选定的时间间隔对日志文件夹中的文件进行分组。 例如，Weekly 选项表示端口每周创建一个新子文件夹并将该周的所有日志存储在该文件夹中。 空白设置告诉端口将所有日志直接保存在 Logs 文件夹中。 对于处理大量事务的端口，使用子文件夹有助于保持日志井井有条并提高性能。
• 保留消息副本 选中此项可使已处理文件的日志条目包含文件本身的副本。 如果禁用此功能，可能无法从 输入 或 输出 选项卡下载文件的副本。

特殊设置

特殊设置 适用于特定用例。

• 其他设置 允许在以分号分隔的列表中配置隐藏的端口设置，例如setting1=value1;setting2=value2。 正常的端口用例和功能不需要使用这些设置。