函数
Version 26.2.9636
函数
Version 26.2.9636
API 函数扩展了可以在 Admin API 资源上执行的操作。函数还可以执行与特定资源无关的操作。函数始终通过 HTTP POST 调用。
每个函数均使用规则 /api.rsc/actionName 在专用的应用程序接口公开例如,例如,知行之桥托管在 “mydomain.com” 上并监听 8001 端口,则将使用以下接口来访问 cleanup 函数:
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 将加密密钥(通常从生产环境导出)导入到开发或测试实例中,使开发环境能够解密来自生产备份或导入的配置数据和凭据。
- receiveFile 指示指定的端口触发端口的接收操作,下载/接收指定的文件(适用于 FTP、SFTP 和 S3 端口),或基于端口配置的所有适用文件。
- requeueMessage 将消息移回 Send 文件夹的处理队列以便重新处理。
- sendFile 命令端口处理(上传、发送、转换等)端口 Send 文件夹中的文件。
- setFlow 为指定的工作区设置工作流。