本文介绍在 Node.js 服务端(云函数、云托管、自建服务器)访问 CloudBase 服务的 SDK 选择与使用方式。
重要:
@cloudbase/node-sdk 已停止维护(4.x next 版本完全基于 @cloudbase/js-sdk 设计)。新项目请直接使用 @cloudbase/js-sdk v3 进行开发,该版本已支持 Node.js 端全部功能。存量项目可参考本文末尾的存量 SDK 入口。说明:
方式一:JS SDK v3(推荐)
npm install @cloudbase/js-sdk @cloudbase/signature-nodejs -S
const cloudbase = require("@cloudbase/js-sdk");const app = cloudbase.init({env: "your-env-id", // 替换为您的环境 ID});// 在普通事件云函数 / 云托管中,SDK 自动读取环境鉴权信息const db = app.database();const result = await db.collection("todos").get();
注意:
在普通事件云函数或云托管环境中,SDK 会自动从环境变量读取鉴权信息,无需手动配置密钥。Web 云函数(HTTP 云函数)必须显式传入
accessKey 或 secretId / secretKey,详见 Node.js 端鉴权。初始化参数
字段 | 类型 | 必填 | 说明 |
env | string | 否 | CloudBase 环境 ID;未指定时使用当前云函数所在环境 |
accessKey | string | 否 | CloudBase API Key,优先级最高的鉴权方式,也可通过环境变量 CLOUDBASE_APIKEY 配置 |
secretId | string | 否 | 腾讯云 API 密钥 secretId,也可通过 TENCENTCLOUD_SECRETID 配置 |
secretKey | string | 否 | 腾讯云 API 密钥 secretKey,也可通过 TENCENTCLOUD_SECRETKEY 配置 |
sessionToken | string | 否 | 临时密钥 Token,通过申请扮演角色临时访问凭证接口获取 |
credentials | object | 否 | CloudBase 私钥( private_key / private_key_id),用于自定义登录签发 ticket |
context | Context | 否 | 函数型云托管入口函数 context,用于免签名调用 |
timeout | number | 否 | 接口调用超时时间(ms),默认 15000 |
方式二:node-sdk(存量项目,已停止维护)
npm install @cloudbase/node-sdk -S
import tcb from "@cloudbase/node-sdk";// 云函数环境使用 commonjs 引入:const tcb = require('@cloudbase/node-sdk')const app = tcb.init({env: "your-env-id", // 替换为您的环境 ID});const db = app.database();const result = await db.collection("todos").get();
能力索引
能力 | 文档 |
初始化与鉴权 | |
文档型数据库 | |
PostgreSQL 数据库 | |
MySQL 数据库 | |
云函数 | |
云存储 | |
登录认证 | |
环境管理 | |
AI 能力 | |
更新日志 |
相关文档
文档站:JS SDK 初始化 · 环境介绍