跳到主要内容

基础环境

环境管理​

平台版环境管理

env create、env modify、env delete、env usage 四个命令支持平台版:通过 --platform-id <platformId> 指定平台版资源池 ID 即进入平台版模式;未指定时保持普通模式行为不变。平台版是账号维度的套餐方案,详见平台版概述。

查看环境列表​

查看所有云开发环境信息:

tcb env list

默认每次展示 20 个环境,环境较多时可通过 --limit / --offset 分页查看:

# 每页 50 个,查看第 2 页
tcb env list --limit 50 --offset 50
参数说明默认值
--limit <limit>返回条数上限,取值 1-10020
--offset <offset>跳过的条数0
  • 表格下方会显示当前展示的范围;本页取满时,会提示查看下一页的完整命令
  • --json 输出的 meta 为 { limit, offset, hasMore },不包含总数。脚本翻页时,hasMore 为 false 即表示已到最后一页

环境 ID 是环境的唯一标识,在全局范围内唯一。环境名称可自定义,用于区分不同环境。

Status 表示环境状态,只有状态正常时才可操作函数、数据库、存储等资源。新建环境可能处于初始化状态,请耐心等待。

地域说明:

  • 默认展示当前地域的环境,可通过 --region <region> 参数查询指定地域的环境,例如 tcb env list --region ap-singapore
  • 标准对外地域:ap-shanghai(上海)、ap-singapore(新加坡)
  • ap-guangzhou(广州)按白名单提供;ap-beijing(北京)暂不提供

环境 ID 解析优先级​

v3.0.0+

CloudBase CLI v3.0.0 引入了全局默认环境配置(tcb env use),环境 ID 的解析优先级为(低 → 高):

全局配置(tcb env use)< 项目 cloudbaserc.json < 命令行 -e / --env-id

即:命令行参数 -e 始终优先,其次是项目 cloudbaserc.json,最后才是全局默认环境。

设置默认环境​

v3.0.0+

设置全局默认环境 ID,设置后后续命令可省略 -e 参数:

# 设置默认环境
tcb env use <envId>

# 查看当前默认环境
tcb env use

# 清除默认环境
tcb env use --unset

修改环境别名​

修改云开发环境的别名:

tcb env rename <name> -e <envId>

创建环境​

v3.0.0+

创建新的云开发环境:

# 交互式创建(无参数时展示可选套餐列表)
tcb env create

# 指定参数创建
tcb env create --alias <别名> --package <套餐Id> --region ap-shanghai --duration 1

# 在平台版资源池下开通环境(v3.8.3+,无需指定套餐)
tcb env create --platform-id <platformId> --alias <别名> --yes

命令参数:

参数说明默认值
--alias <alias>环境别名—
--package <package>套餐 ID,见下方套餐列表;不填时展示套餐列表供选择—
--region <region>环境地域ap-shanghai
--duration <duration>购买时长(月),可选值:1-12、241
--auto-renew开启自动续费否
--external-storage-bucket <bucket>云存储使用的共享 COS 桶名称,需与下面两个参数同时指定,见使用共享 COS 桶—
--external-storage-region <region>共享桶所在地域,例如 ap-shanghai—
--external-storage-base-path <basePath>当前环境在共享桶内的目录前缀,同一共享桶内各环境需唯一—
--yes非交互模式,跳过确认提示—
--platform-id <platformId>平台版资源池 ID,指定后在平台版资源池下开通环境;与 --package / --region / --duration / --auto-renew / --postgresql 互斥—

套餐 ID 参考:

套餐 ID套餐名称适用场景
baas_personal个人版新手入门,高性价比
baas_pf_standard标准版小团队
baas_pf_enterprise企业版中小企业

套餐价格与详细配额请参考 云开发定价页面。

使用共享 COS 桶​

单账号下的 COS 桶数量有配额上限。需要创建大量环境时,可以让多个环境的云存储共用一个 COS 桶,各环境的文件放在各自的目录前缀(BasePath)下:

tcb env create --alias tenant-a --package baas_personal --yes \
--external-storage-bucket my-bucket-1250000000 \
--external-storage-region ap-shanghai \
--external-storage-base-path tenant-a

变更套餐​

v3.0.0+

变更环境套餐(升降配):

# 交互式变更(只输入 envId 时展示可变更套餐列表)
tcb env modify -e <envId>

# 指定目标套餐
tcb env modify --package <套餐Id或编号> -e <envId>
参数说明
--package <package>目标套餐 ID 或编号(套餐 ID 同上方套餐列表;不填时展示可变更套餐列表)
-e, --env-id <envId>云开发环境 ID
--yes跳过确认提示

平台版环境状态变更(v3.8.3+):指定 --platform-id 后变更平台版环境状态(环境启/禁用、云存储 / FlexDB 资源状态),与 --package 互斥,仅显式指定的字段会更新:

# 平台版:禁用环境
tcb env modify --platform-id <platformId> -e <envId> --status DISABLE --yes

# 平台版:将云存储设为只读
tcb env modify --platform-id <platformId> -e <envId> --storage-status READONLY --yes
参数说明
--platform-id <platformId>平台版资源池 ID,指定后变更平台版环境状态
--status <status>平台版环境状态:ENABLE(启用)/ DISABLE(禁用)
--storage-status <status>平台版云存储状态:ENABLE(正常)/ DISABLE(彻底禁用)/ READONLY(只读)
--flexdb-status <status>平台版 FlexDB(文档型数据库)状态:ENABLE(正常)/ DISABLE(彻底禁用)/ READONLY(只读)

续费环境​

v3.0.0+

续费云开发环境:

tcb env renew -e <envId>

# 指定续费时长
tcb env renew --duration 3 -e <envId>
参数说明默认值
--duration <duration>续费时长(月)1
-e, --env-id <envId>云开发环境 ID—
--yes跳过确认提示—

销毁环境​

v3.0.0+

销毁云开发环境(不可恢复,请谨慎操作):

tcb env delete -e <envId>

# 预览销毁影响范围(不实际执行)
tcb env delete -e <envId> --dry-run

# 跳过确认
tcb env delete -e <envId> --yes

命令参数:

参数说明
-e, --env-id <envId>环境 ID(必填)
--yes跳过确认提示
--dry-run模拟运行,仅展示环境信息和影响范围,不实际执行销毁
--platform-id <platformId>平台版资源池 ID,指定后销毁平台版资源池下的环境,资源池本身及其他环境不受影响(v3.8.3+)

平台版示例(v3.8.3+):

# 销毁平台版环境
tcb env delete --platform-id <platformId> -e <envId> --yes

# 预览平台版销毁影响范围
tcb env delete --platform-id <platformId> -e <envId> --dry-run
注意

销毁环境会删除该环境下的所有资源(云函数、数据库、存储等),操作不可恢复。建议先使用 --dry-run 预览。

查看环境资源配置详情​

查看环境下各资源(数据库、存储、云函数、静态托管、日志服务)的唯一标识和配置:

tcb env detail -e <envId>

输出示例:

🔧 资源配置
📦 数据库 [未开通]
📁 对象存储 Bucket: 7072-prod-xxx-1326375956 地域: ap-shanghai
⚡ 云函数 [未开通]
🌐 静态托管 [未开通]
📊 日志服务 [未开通]

与 env usage / env info 的区别:

命令查看内容
tcb env detail环境配置了哪些资源(唯一标识、地域等)
tcb env usage资源用量汇总
tcb env info资源指标明细(按时间范围)

地域说明:环境归属特定地域,查询结果为空或提示「环境不存在」时,可能是地域不匹配,可通过 -r <region> 指定地域后重试,例如 tcb env detail -e <envId> -r ap-singapore。

查看资源用量​

v3.0.0+

查看环境资源使用详情:

tcb env usage -e <envId>

平台版环境用量查询(v3.8.3+):指定 --platform-id 后查询平台版环境按资源类型的用量与资源点消耗,此模式下环境 ID 必填:

# 查询平台版环境用量
tcb env usage --platform-id <platformId> -e <envId> --yes

# 指定资源类型(JSON 输出)
tcb env usage --platform-id <platformId> -e <envId> --resource-types Storage,Function --json --yes

# 指定时间范围并展示用量明细
tcb env usage --platform-id <platformId> -e <envId> --start-date 2026-09-01 --end-date 2026-09-15 --need-details
参数说明
--platform-id <platformId>平台版资源池 ID,指定后查询平台版环境用量
--start-date <date>查询起始日期,格式 YYYY-MM-DD
--end-date <date>查询结束日期,格式 YYYY-MM-DD
--resource-types <types>资源类型,多个用逗号分隔:Database / Function / Storage / HOSTING / Log / Gateway / Cloudrun / Token / EO,默认全部
--need-details展示用量明细

查看资源指标明细​

v3.0.0+

查看环境资源指标用量明细,支持按时间范围过滤:

tcb env info -e <envId>

# 指定时间范围
tcb env info -e <envId> --start-date 2025-01-01 --end-date 2025-01-31
参数说明
--start-date <date>开始日期,格式 YYYY-MM-DD
--end-date <date>结束日期,格式 YYYY-MM-DD
-e, --env-id <envId>云开发环境 ID
--yes跳过确认提示

安全域名管理​

提示

安全域名管理已迁移到独立的 tcb cors 命令,功能更完整。建议使用新命令,详见 安全域名管理。

以下命令仍可用(兼容保留):

查看安全域名​

tcb env domain list -e <envId>

添加安全域名​

tcb env domain create <domain> -e <envId>

删除安全域名​

tcb env domain delete -e <envId>

命令速查​

命令说明版本
tcb env list查看环境列表v1+
tcb env use <envId>设置全局默认环境v3.0.0+
tcb env use --unset清除全局默认环境v3.0.0+
tcb env rename <name>修改环境别名v1+
tcb env create创建新环境v3.0.0+
tcb env modify变更环境套餐v3.0.0+
tcb env renew续费环境v3.0.0+
tcb env delete销毁环境v3.0.0+
tcb env detail查看环境资源配置详情v3.0.0+
tcb env usage查看资源用量v3.0.0+
tcb env info查看资源指标明细v3.0.0+

env create / env modify / env delete / env usage 支持通过 --platform-id <platformId> 操作平台版资源池(v3.8.3+)。