跳到主要内容

tcb integration create

从 cloudbaserc.json 的 integrations 字段创建集成实例。不传位置参数时批量创建配置中的所有集成。

语法​

tcb integration create [name] [--keyid <keyId>] [--yes] [--json]

快速开始​

1. 初始化集成配置​

# 按集成类型交互选择
tcb config init integration stripe-test

# 直接指定集成类型
tcb config init integration stripe-test --type stripe-pay

位置参数可以是实例名称(name)或 keyId:先按 keyId 精确匹配,未命中再按名称匹配;同名多个时需改用 keyId 指定。tcb config init integration 会按名称生成 keyId 并写入配置:

集成标识 keyId:stripe-test-a1b2c3d4(系统生成,用于回调域名,创建后不可更改)

2. 完善配置​

编辑生成的 cloudbaserc.json,把占位符替换为实际值:

{
"envId": "env-abc123",
"integrations": [
{
"keyId": "stripe-test-a1b2c3d4",
"name": "stripe-test",
"authTypeCode": "stripe-pay",
"description": "Stripe 支付",
"envVariables": {
"stripeSecretKey": "sk_live_xxx"
}
}
]
}

3. 创建集成​

tcb integration create

keyId 规则​

keyId 会被拼进回调域名 {keyId}.integration-callback.tcloudbase.com,创建后不可更改。

项规则
是否必填否。缺省时按 name 自动生成并写回配置
生成格式<name 转成的短标识>-<8 位随机串>,例如 stripe-test-a1b2c3d4
短标识只保留小写字母、数字与连字符;其他字符(含中文)丢弃,全部丢弃时为 integration;最长 24 字符
合法格式^[a-z0-9]([a-z0-9-]*[a-z0-9])?$,长度不超过 63 字符(DNS 标签上限)
撞车处理自动生成的 keyId 被云端判定已存在时,换随机后缀重试,最多 3 次;显式指定的 keyId 不重试

⚠️ 生成的 keyId 会回写 cloudbaserc.json。只支持 JSON 配置:非 JSON 配置不回写,CLI 会告警并列出待手动补充的 keyId。

位置参数解析​

[name] 先按 keyId 精确匹配(兼容旧脚本 create <keyId>),未命中再按 name 匹配:

  • 同名命中多条:报错并列出候选 keyId,不替你猜
  • keyId 和 name 都未命中:报错并列出配置中的全部集成

参数​

参数说明必填
<name>要创建的集成,可传 keyId 或 name;不指定则批量创建所有集成否
--keyid <keyId>显式指定实例标识。格式不合法直接报错;配置项已有不同 keyId 时也报错否
--yes跳过确认否
--json以 JSON 格式输出否

示例​

批量创建集成​

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

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

创建指定集成​

# 按 name 创建(配置里已有对应 keyId 或 keyId 由 CLI 生成)
tcb integration create stripe-test

# 按 keyId 创建
tcb integration create stripe-test-a1b2c3d4

显式指定 keyId​

tcb integration create stripe-test --keyid stripe-test-a1b2c3d4

输出示例​

✓ 集成实例创建成功:stripe-test

下一步:
查看详情 tcb integration get stripe-test-a1b2c3d4
绑定云函数 tcb integration bind-resource stripe-test-a1b2c3d4 --function <function-name>

批量创建完成:成功 1 个,失败 0 个

批量创建​

在 integrations 数组中配置多个集成实例即可批量创建:

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

执行 tcb integration create 后,CLI 并发创建(每批最多 5 个),并把生成的 keyId 逐个回写配置文件。

回调地址​

回调地址由 CLI 按集成类型生成后再提交,避免第三方平台配错地址:

  • 模板声明了 callbackUrlParam.urlTemplate 时,按模板生成
  • 微信系集成(weixin* / wx*)使用 /wechat/notify、/wechatpay/order、/wechatpay/refund
  • stripe-pay 使用 /stripe/webhook
  • 其他未登记回调路径的集成不生成回调地址,交给云端生成——套用微信路径会被云端判为「webhook 回调地址不正确」

已登记的地址会随 keyId 变化重算,配置里手改无效。

错误处理​

配置文件格式错误时,CLI 列出全部错误后终止:

配置文件格式错误:
1. integrations[0].authTypeCode 不能为空
2. integrations[0]: 标识 keyId 只允许小写字母、数字和连字符(-),不能以连字符开头或结尾(当前值:Stripe-Test)

注意事项​

  • authTypeCode 必填,取值见 tcb integration types
  • name 可重复,未填写时使用 keyId
  • 认证类型创建后不可修改
  • 配置了 demoCodeFunctionName 时,创建成功后自动绑定该云函数;函数需先 tcb fn deploy 部署
  • --verbose 日志只对凭证类字段脱敏,回调地址、类型等结构字段保持可读