跳到主要内容

创建集成

使用 tcb integration create [keyId] 命令通过配置文件创建集成实例。指定 keyId 位置参数时只创建对应的单个集成；不指定则批量创建配置文件中的所有集成。

快速开始​

1. 初始化集成配置​

不同类型的集成有不同的环境变量要求，建议使用 tcb config init integration 命令生成配置模板：

# 交互式初始化（会自动拉取可用的集成类型供选择）
tcb config init integration <keyId>

# 直接指定集成类型
tcb config init integration <keyId> --type weixinpaydc

执行后，CLI 会：

  1. 选择环境（如果未通过 -e 指定）
  2. 选择集成类型（从 CMS 拉取可用的集成类型模板）
  3. 输入集成名称（可选，默认使用 keyId）
  4. 拉取模板字段定义，生成 envVariables 配置模板（包含字段说明和必填标记）
  5. 生成 cloudbaserc.json 配置文件

示例输出：

? 请选择集成类型 微信支付 (weixinpaydc)
? 请输入集成名称（可选，仅用于显示）

配置已保存到 /path/to/cloudbaserc.json

📝 下一步：
  1. 编辑 cloudbaserc.json 文件，完善集成配置参数
  2. 运行 tcb integration create 创建集成实例

📋 字段说明：
  - mch_id（必填） - 商户 ID
  - api_key（必填） - 敏感字段

2. 完善配置​

编辑生成的 cloudbaserc.json 文件，将占位符替换为实际值：

{
  "envId": "env-abc123",
  "integrations": [
    {
      "keyId": "key-abc123",
      "name": "key-abc123",
      "authTypeCode": "weixinpaydc",
      "description": "微信支付集成",
      "envVariables": {
        "mch_id": "your-mch-id",
        "api_key": "your-api-key"
      }
    }
  ]
}

3. 创建集成​

tcb integration create

配置文件模式​

tcb integration create 从 cloudbaserc.json 配置文件中读取 integrations 字段创建集成实例。您可以先在配置文件中配置 integrations 字段，然后执行命令创建。

配置文件格式​

在 cloudbaserc.json 中添加 integrations 字段：

{
  "integrations": [
    {
      "keyId": "key-abc123",
      "name": "my-integration",
      "authTypeCode": "custom",
      "description": "我的集成",
      "envVariables": {
        "AppId": "your-app-id",
        "AppSecret": "your-app-secret"
      },
      "demoCodeFunctionName": "my-function"
    }
  ]
}

配置字段说明​

字段类型必填说明
keyIdstring是集成实例唯一标识（用于匹配已有实例）
namestring否集成实例名称（仅用于显示，未填写时使用 keyId 作为默认值）
authTypeCodestring是认证类型 Code，如 custom、wechat 等
descriptionstring否集成实例描述
envVariablesobject否环境变量配置（key-value 对）
demoCodeFunctionNamestring否要绑定的云函数名称

提示：authTypeCode 的可选值可以通过 tcb integration types 命令查询。

从文件读取字段值（@ 文件引用语法）​

部分字段（如微信支付的 privateKey、apiV3Key 等）通常是多行文本或较长的敏感内容（例如 PEM 格式私钥）。直接把它们写进 JSON 需要手动把换行符转义为 \n，既繁琐又容易出错。

CLI 支持在 envVariables 的值中使用 @ 前缀直接引用文件，创建时会自动读取该文件内容作为字段值：

{
  "integrations": [
    {
      "keyId": "key-abc123",
      "name": "key-abc123",
      "authTypeCode": "weixinpaydc",
      "description": "微信支付集成",
      "envVariables": {
        "appId": "wx1234567890",
        "apiV3Key": "@./secrets/apiv3key.txt",
        "privateKey": "@./secrets/apiclient_key.pem"
      }
    }
  ]
}

文件引用语法说明：

写法含义
@./certs/key.pem相对路径（相对于 cloudbaserc.json 所在目录）
@/absolute/path/key.pem绝对路径
非 @ 开头的普通字符串按字面值处理（需自行把换行符转义为 \n）

说明：

  • 读取文件内容时会自动去除 BOM 和首尾空白字符，保持 PEM 等格式整洁。
  • 若引用的文件不存在或无法读取，CLI 会报错并中止创建，请检查路径是否正确。
  • 该语法在 tcb integration create 与 tcb config update integration 中均可使用。
  • 建议将密钥文件加入 .gitignore，避免敏感凭证被提交到代码仓库。

命令参数​

参数说明必填
<keyId>要创建的集成实例标识（位置参数，对应配置文件中的 keyId）；不指定则批量创建所有集成否
--yes跳过所有确认（批量创建）否

提示：

  • 命令会批量创建配置文件中的所有集成
  • 如果配置文件中有多个集成，会询问是否批量创建
  • 使用 --yes 参数可以跳过确认，直接批量创建

使用示例​

批量创建集成​

如果配置文件中配置了多个集成，执行命令会询问是否批量创建：

# 交互式确认是否批量创建
tcb integration create

# 跳过确认，直接批量创建所有集成
tcb integration create --yes

创建指定集成​

如果只想创建配置文件中的某一个集成，可以传入 keyId 位置参数：

# 仅创建配置文件中 keyId 为 key-abc123 的集成
tcb integration create key-abc123

# 跳过确认，直接创建指定集成
tcb integration create key-abc123 --yes

输出示例​

✓ 集成实例创建成功：my-integration

下一步：
  查看详情    tcb integration get key-abc123
  绑定云函数  tcb integration bind-resource key-abc123 --function <function-name>

批量创建完成：成功 1 个，失败 0 个

批量创建​

您可以在 integrations 数组中配置多个集成实例，实现批量创建：

{
  "integrations": [
    {
      "keyId": "key-abc123",
      "name": "integration-1",
      "authTypeCode": "custom"
    },
    {
      "keyId": "key-def456",
      "name": "integration-2",
      "authTypeCode": "wechat"
    }
  ]
}

执行 tcb integration create 后，CLI 会并发创建这些集成实例（每批最多 5 个），并输出创建结果。

错误处理​

如果配置文件格式错误，CLI 会报错并列出所有错误信息：

配置文件格式错误：
1. integrations[0].keyId 不能为空
2. integrations[0].authTypeCode 不能为空

请修复配置文件后重新执行。

注意事项​

  • keyId 是集成实例的唯一标识，必填
  • name 只是显示名称，可以重复，未填写时使用 keyId 作为默认值
  • 认证类型创建后不可修改
  • 创建成功后会自动生成 Key ID（格式：key-[32位十六进制]）
  • 如果配置了 demoCodeFunctionName，创建成功后会自动绑定到指定云函数

相关文档​