跳到主要内容

SDK 初始化

init

1. 接口描述

接口功能:SDK 实例初始化

接口声明:init: (config?: ICloudBaseConfig): CloudBase

2. 输入参数

字段类型必填说明
secretIdstring腾讯云 API 固定密钥对 secretId,在云函数内执行可不填。前往控制台获取
secretKeystring腾讯云 API 固定密钥对 secretKey,在云函数内执行可不填。前往控制台获取
sessionTokenstring腾讯云 API 临时密钥对 Token,临时凭证需通过 sts.AssumeRole 接口获取临时访问凭证 查看文档
envstringTCB 环境 ID。如果 SDK 运行在 TCB云函数 环境下,默认使用函数所在环境的环境ID,运行在其他环境缺省该参数则会使用默认境
timeoutnumber调用接口的超时时间(ms),默认为 15000ms,即 15s
proxystring调用接口时使用的 http 代理 url
credentialsobjectCloudbase 私钥,包含 private_keyprivate_key_id 两个字符串,可以登录云开发控制台获取
versionstring版本号,依赖项目的版本号

3. 返回结果

字段类型必填说明
-CloudBasetcb 对象实例

4. 示例代码

import tcb from '@cloudbase/node-sdk'

// 初始化,云函数下可省略 secretId 和 secretKey,env 如果不指定则使用当前函数所在环境的环境ID
const app = tcb.init()
const app = tcb.init({env: 'xxx'})
const app = tcb.init({
secretId: 'xxxxx',
secretKey: 'xxxx',
sessionToken: 'xxxx',
env: 'xxx'
})

// 设置请求超时时间
const app = tcb.init({
timeout: 5000
})

// 初始化环境'xx'和'zz'
const app1 = tcb.init({env: 'xx'})
const app2 = tcb.init({env: 'zz'})