Cloud Functions

callFunction

callFunction(object: Object): Promise<Object>

1. API Description

API feature: Execute Cloud Function

2. Input Parameters

object

Object

namestring

Cloud Function name

data可选object

Cloud Function parameters

callback可选function

callback function

parse可选boolean

When set to true, if the function return is an object, the API request will return the object to be resolved rather than a JSON string, suitable for direct view of returned results during browser debug

CloudBase Run supports additional parameters. After passing the type:'cloudrun' parameter, it will invoke the CloudBase Run service.

object

Object

type可选cloudrun

Whether to call CloudBase Run based Cloud Functions

method可选string

HTTP request method

path可选string

HTTP request path

header可选Record<string, string>

HTTP headers

data可选object

HTTP request body

3. Output Parameters

Promise

Object

code可选string

Status code, do not return if operation succeeded

message可选string

Error Description

result可选object

Cloud Function execution result

requestId可选string

Request Serial Number for fault troubleshooting

4. Example code

Basic Cloud Function call

import cloudbase from "@cloudbase/js-sdk";
// Initialize SDK instance
const app = cloudbase.init({
  env: "xxxx-yyy",
});

app
  .callFunction({
    name: "test",
    data: { a: 1 },
  })
  .then((res) => {
    const result = res.result; //Cloud Function execution result
  });

Functional CloudBase Run call

import cloudbase from "@cloudbase/js-sdk";
// Initialize SDK instance
const app = cloudbase.init({
  env: "xxxx-yyy",
});

app
  .callFunction({
    name: "test",
    // CloudBase Run parameters
    type: "cloudrun",
    method: "POST",
    path: "/abc",
    data: {
      key1: "test value 1",
      key2: "test value 2",
    },
  })
  .then((res) => {
    const result = res.result; //Cloud Function execution result
  });