跳到主要内容
支持地域：上海

微搭私有部署云函数操作指引

本文档将指导您在微搭私有部署环境中完成云函数的开发、部署和调用。

功能说明

目前微搭私有化版本的云函数调用仅支持 HTTP API 方式。

步骤 1：编写云函数​

1.1 开发参考文档​

在开始云函数开发前，建议先阅读以下官方文档：

1.2 开发建议​

开发提示
  • 建议先在本地完成开发和测试，确保函数运行正常后再上传部署
  • 确保所有依赖包都已正确安装
  • 注意函数的入口文件和处理方法配置

步骤 2：部署云函数​

2.1 下载部署工具​

首先需要下载云函数发布上传工具 private-cloud-function（简称 pcf）。

Linux 系统​

# 下载工具
wget https://software-1302110647.cos.ap-guangzhou.myqcloud.com/rc/lastest/tools/amd64/linux/pcf

# 添加执行权限
chmod +x pcf

Windows 系统​

# 下载地址
https://software-1302110647.cos.ap-guangzhou.myqcloud.com/rc/lastest/tools/amd64/windows/pcf.exe

macOS 系统​

# 下载工具
wget https://software-1302110647.cos.ap-guangzhou.myqcloud.com/rc/lastest/tools/amd64/macOS/pcf

# 添加执行权限
chmod +x pcf
Windows 用户说明

对于 Windows 系统用户，可以按 Win + R 打开运行对话框，输入 cmd 打开命令提示符。下载 pcf.exe 后，在命令行中使用 .\pcf.exe 替代 ./pcf 执行命令。

Windows命令行示例

2.2 配置登录信息​

使用以下命令添加微搭环境的登录信息：

./pcf add-host <aliasname> --host=<登录地址> --username=<用户名> --password=<密码>

参数说明：

  • aliasname：主机别名，用于标识不同的微搭环境（可选，默认为 default）
  • host：微搭私有部署的访问地址
  • username：管理员用户名
  • password：管理员密码

示例：

./pcf add-host --host=http://192.168.1.100 --username=admin --password="Weda@123456"

2.3 上传云函数代码​

将本地开发完成的云函数代码上传到微搭环境：

./pcf func push <funcname> --alias=<aliasname> --path=<代码路径>

参数说明：

  • funcname：函数的唯一标识名称
  • alias：之前配置的主机别名
  • path：本地云函数代码的路径

示例：

# 使用官方模板示例
# 1. 先下载模板：https://github.com/TencentCloudBase/func-v2-template
# 2. 本地测试通过后执行上传
./pcf func push myfunction --path="/data/code/func-v2-template"
上传提示
  • 确保代码路径正确，包含完整的函数代码和依赖
  • 建议先在本地测试通过后再上传
  • 上传前检查代码中的依赖是否完整

2.4 发布云函数​

上传完成后，需要发布云函数使其生效：

./pcf func deploy <funcname> --alias=<aliasname>

示例：

./pcf func deploy myfunction

发布成功后，系统会返回部署结果信息。

步骤 3：在 APIs 连接器中调用云函数​

云函数发布成功后，可以通过微搭的 APIs 连接器来调用。

3.1 选择 APIs 类型​

在微搭低代码平台中：

  1. 进入 扩展能力 → 资源链接 → APIs 连接器
  2. 选择 自定义 APIs → HTTP 请求

3.2 配置 APIs 方法​

在 APIs 连接器配置界面中，填写以下信息：

基础配置：

  • URL：http://func-server:3000
  • 请求方法：根据云函数代码中定义的方法选择（如 POST、GET 等）
  • 请求头：根据需要添加（如 Content-Type: application/json）

APIs连接器配置示例

3.3 测试 APIs 方法​

配置完成后，可以在 APIs 连接器中直接测试：

  1. 点击 测试 按钮
  2. 输入测试参数（如有需要）
  3. 查看返回结果

APIs测试示例

调用说明
  • 云函数的访问地址固定为 http://func-server:3000
  • 请求方法需要与云函数代码中定义的方法保持一致
  • 可以在测试通过后将 APIs 绑定到具体的页面组件中使用

步骤 4：其他管理命令​

4.1 删除登录信息​

如需删除已配置的主机登录信息：

./pcf del-host <aliasname>

4.2 查询云函数列表​

查看当前环境中的所有云函数：

./pcf func list --alias=<aliasname>
函数状态说明

系统会返回函数列表，显示每个函数的状态。注意：同一时间只能有一个函数处于已发布状态，其他函数均为未发布状态。

4.3 删除云函数​

删除不需要的云函数：

./pcf func del <funcname> --alias=<aliasname>

步骤 5：问题排查​

当云函数部署或运行出现问题时，可以通过以下方式进行排查。

5.1 查看服务级别日志​

如果云函数存在语法错误或部署失败，需要查看 func-server 容器的日志。

单机版部署​

# 查看最近100条日志
docker logs -f -n 100 func-server

集群版部署​

# 1. 查看 func-server Pod 名称
kubectl -n software get pods | grep func-server

# 2. 查看指定 Pod 的日志
kubectl -n software logs -f --tail=100 <func-server-pod-name>

常见错误示例：

当出现依赖缺失或语法错误时，日志中会显示相应的错误信息。建议在本地完成测试并安装所有依赖后再上传部署。

错误日志示例

5.2 查看用户级日志​

进入容器查看详细日志​

用户级日志存储在以下目录中：

/workspace/logs/accesslog*.log      # 访问日志
/workspace/logs/usercodelog*.log    # 用户代码日志

进入容器的方法​

单机版部署：

docker exec -it func-server bash

集群版部署：

# 1. 查看 func-server Pod 名称
kubectl -n software get pods | grep func-server

# 2. 进入指定的 Pod
kubectl -n software exec -it <func-server-pod-name> -c func-server bash

进入容器后，可以使用 tail、grep 等命令查看和分析日志文件。

总结​

通过以上步骤，您已经完成了：

  1. ✅ 云函数的本地开发和测试
  2. ✅ 部署工具的下载和配置
  3. ✅ 云函数的上传和发布
  4. ✅ 在微搭平台中通过 APIs 连接器调用云函数
  5. ✅ 掌握了基本的管理和排查方法

现在您可以在微搭私有部署环境中充分利用云函数的能力，为您的低代码应用提供强大的后端服务支持。

最佳实践建议
  • 建议在本地充分测试云函数后再上传部署
  • 定期查看日志，及时发现和解决问题
  • 合理规划函数命名，便于管理和维护
  • 注意函数的资源使用情况，避免影响系统性能