> ## 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 函数概览，用于执行标准资源 CRUD 之外的操作。

API 函数扩展了可对[系统 API 资源](https://docs.kasoftware.com/26.4/self-hosted/zh/admin-api/admin-api-resources.md)执行的操作集。函数也可以执行与特定资源无关的操作。函数始终使用 HTTP POST 调用。

每个函数都使用以下约定在专用的应用程序端点公开：`/api.rsc/actionName`。例如，如果 知行之桥 托管在 **mydomain.com** 上并监听 8001 端口，则将使用以下端点来访问 **cleanup** 函数：

```xml theme={null}
POST http://mydomain.com:8001/api.rsc/cleanup
```

函数参数在 HTTP POST 的 JSON 格式正文中指定。请求必须包含适当的 content-type 头部（例如 application/json），以便正确解释 POST 正文。点击 知行之桥 导航栏上的 **API** 可查看每个函数的可用参数。

系统 API 包含以下函数：

| 函数 | 描述 |
| - | - |
| **cleanup** | 归档或删除日志文件、数据库中的事务条目，以及（可选）指定工作区和端口的 Send、Sent 和 Received 文件夹中的文件。 |
| **copyConnector** | 使用现有端口配置创建新的 知行之桥 端口。 |
| **copyWorkspace** | 创建新的 知行之桥 工作区，并复制现有工作区中的所有端口。 |
| **createCert** | 创建新的数字证书（公钥/私钥对），用于加密、签名、解密、验证、SSL/TLS 等。 |
| **exchangeCert** | 与交易伙伴交换指定证书的公钥。仅适用于 AS2 和 OFTP 端口。 |
| **export** | 根据个人设置、端口设置或工作区设置创建配置文件（`.arcflow`）。 |
| **exportDataEncryptionKey** | 将主加密密钥导出为加密数据块，其中包含数据加密密钥及其相关加密元数据。 |
| **getMessageCount** | 检索一个或多个工作区中所有端口未发送消息的数量。 |
| **getTransactionLogs** | 检索特定事务的详细事务日志数据。 |
| **import** | 从配置归档文件（`.arcflow`）将个人设置、端口设置或工作区设置导入到 知行之桥。 |
| **importDataEncryptionKey** | 将加密密钥（通常从生产环境导出）导入到开发或测试实例中，使开发环境能够解密来自生产备份或导入的配置数据和凭据。 |
| **moveConnector** | 将端口（包括其设置、状态、凭据引用和事务历史记录）从**工作流**页面上的一个工作区移动到另一个工作区，或在同一工作区中重命名该端口。移动成功后，原端口将被删除。端口移动到其他工作区时，与其他端口之间的连接会被断开。 |
| **moveConnectors** | 将一组端口（包括其设置、状态、凭据引用和事务历史记录）从**工作流**页面上的一个工作区移动到另一个工作区，并保留这些端口之间的现有连接。与该组之外的端口之间的连接会被断开，并在响应中列出。移动成功后，原端口将被删除。 |
| **receiveFile** | 指示特定端口触发端口的接收操作，以下载/接收特定文件（适用于 FTP、SFTP 和 S3 端口）或所有适用文件（基于端口配置）。 |
| **refreshAPICredential** | 为用户重新生成 authtoken 或客户端密钥，并返回新的明文值。重新生成客户端密钥要求该用户已启用 OAuth 访问。只有具有[管理员角色](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/user-roles.md#管理员角色)的用户才能调用此函数。 |
| **requeueMessage** | 将消息移回 Send 文件夹处理队列，以便重新处理。 |
| **sendFile** | 指示端口处理（上传、发送、转换等）该端口 Send 文件夹中的文件。 |
| **setFlow** | 为指定工作区设置流程连接。 |


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