概述

提示

v3 版本在调用云存储相关 API 时，使用的是 云函数 HTTP API 的开放能力。在使用前，请前往 云开发平台/身份认证/权限控制 确认 FunctionsHttpApiAllow 的策略管理配置是否符合预期。详细说明请参考策略管理说明文档

callFunction

callFunction<T = any>(object: Object): Promise<Result<ICallFunctionResponse<T>>>

执行云函数。

支持调用普通云函数和函数型云托管
传入 type: 'cloudrun' 参数后，将调用函数型云托管服务

GATEWAY 通道

网关模式下按 HTTP statusCode 判定成败：2xx 视为成功（即使响应体含 code 字段）；非 2xx 时解析 JSON / HTML / 纯文本错误体。init({ throw: false }) 时返回 {code, message, requestId}，默认抛出错误。

参数

object

Object

namestring

云函数名称

data可选object

云函数参数

callback可选function

回调函数

parse可选boolean

设置为 true 时，当函数返回值为对象时，API 请求会返回解析对象，而不是 JSON 字符串，适用于在浏览器调试时直接查看返回结果

type可选string

传入 'cloudrun' 时调用函数型云托管服务

method可选string

HTTP 请求方法（函数型云托管）

path可选string

HTTP 请求路径（函数型云托管）

header可选Record<string, string>

HTTP 请求头（函数型云托管）

Promise

Object

示例

基础云函数调用
函数型云托管调用

import cloudbase from "@cloudbase/js-sdk";

const app = cloudbase.init({
  env: "xxxx-yyy",
});

app
  .callFunction({
    name: "test",
    data: { a: 1 },
  })
  .then((res) => {
    const result = res.result; // 云函数执行结果
  });

import cloudbase from "@cloudbase/js-sdk";

const app = cloudbase.init({
  env: "xxxx-yyy",
});

app
  .callFunction({
    name: "test",
    type: "cloudrun",
    method: "POST",
    path: "/abc",
    data: {
      key1: "test value 1",
      key2: "test value 2",
    },
  })
  .then((res) => {
    const result = res.result; // 云函数执行结果
  });

Node.js 端工具方法

Node.js 端

以下方法仅在 Node.js 环境中有效。

sendTemplateNotification

app.sendTemplateNotification(params: object, opts?: object): Promise<object>

发送模板消息通知。

需在云开发平台/消息通知管理中预先配置通知策略
触发方式选择「手动触发」

参数

params

Object

opts

Object

Promise

Object

示例

基础示例

const cloudbase = require("@cloudbase/js-sdk");

const app = cloudbase.init({
  env: "your-env-id",
});

exports.main = async (event, context) => {
  const result = await app.sendTemplateNotification({
    notifyId: "your-notify-id",
    data: { orderId: "ORD-001", amount: 200 },
    url: "https://your-domain.com/order/detail",
  });
  console.log(result);
};

parseContext

app.parseContext(context: object): object

解析云函数入口函数的 context 参数，将运行时环境变量转换为结构化对象。

仅在云函数环境中有效

参数

context

object

云函数入口函数的 context 参数

返回值

Object

示例

基础示例

const cloudbase = require("@cloudbase/js-sdk");

exports.main = async (event, context) => {
  const app = cloudbase.init({ env: "your-env-id" });

  const envObj = app.parseContext(context);
  console.log(envObj);
};

callFunction​

参数

返回

示例

Node.js 端工具方法​

sendTemplateNotification​

参数

返回

示例

parseContext​

参数

返回

示例

callFunction

Node.js 端工具方法

sendTemplateNotification

parseContext