Alibaba Cloud Function Compute

https://help.aliyun.com/zh/functioncompute
Admin
Alibaba Cloud Function Compute is a fully managed serverless computing service that enables...
Tokens:1,277,992
Snippets:7,050
Trust Score:10
Update:1 day ago
Show doc for...
Tokens:
Raw
### Python: Start HTTP server and get public host

Source: https://help.aliyun.com/zh/functioncompute/overview-3

Python equivalent of the TypeScript example: runs the HTTP server in the background, gets the host with sandbox.get_host(8000), prints the HTTPS URL, and kills the server.

```python
server = sandbox.commands.run(
    "python3 -m http.server 8000",
    background=True,
)

host = sandbox.get_host(8000)
print(f"https://{host}")

sandbox.commands.kill(server.pid)
```

--------------------------------

### 运行 Python 示例

Source: https://help.aliyun.com/zh/functioncompute/using-the-cloud-sandbox-via-the-sdk

运行 quickstart.py。

```bash
python3 quickstart.py
```

--------------------------------

### Error: Function instance exited unexpectedly (code 145) with start command 'dotnet ./target/NotExistFile.dll'

Source: https://help.aliyun.com/zh/functioncompute/troubleshooting-2

Example error message and log when the .NET DLL file is missing or .NET SDK is not installed, showing exit code 145.

```csharp
Function instance exited unexpectedly(code 145) with start command 'dotnet ./target/NotExistFile.dll '.
Logs:Could not execute because the application was not found or a compatible .NET SDK is not installed.
Possible reasons for this include:
  * You intended to execute a .NET program:
      The application './target/NotExistFile.dll' does not exist.
  * You intended to execute a .NET SDK command:
      It was not possible to find any installed .NET SDKs.
      Install a .NET SDK from:
        https://aka.ms/dotnet-download
```

--------------------------------

### Install openapi-util SDK

Source: https://help.aliyun.com/zh/functioncompute/configure-signature-authentication-for-http-triggers

Run this command to install the required SDK for signature authentication in Go.

```bash
go get github.com/alibabacloud-go/openapi-util/service
```

--------------------------------

### Bash: Run TypeScript example with npm and npx

Source: https://help.aliyun.com/zh/functioncompute/use-the-computer-use-sandbox

Commands to install dependencies and run the TypeScript example using npx tsx.

```bash
npm install
npx tsx computer-use.ts
```

--------------------------------

### Run Go example after module replacement

Source: https://help.aliyun.com/zh/functioncompute/e2b-sdk-java-and-go

Resolve local replacements and run the Go example.

```bash
go mod tidy
go run .
```

--------------------------------

### 下载build-fc-zip工具（Windows）

Source: https://help.aliyun.com/zh/functioncompute/compile-and-deploy-code-packages-in-a-go-runtime

使用go install方式下载build-fc-zip工具，设置GOOS和GOARCH为windows环境，工具通常安装在%USERPROFILE%\go\bin目录下。

```go
set GOOS=windows
set GOARCH=amd64
go install github.com/aliyun/fc-runtime-go-sdk/cmd/build-fc-zip@latest
```

--------------------------------

### Python: Start HTTP server and get public URL with sandbox.get_host

Source: https://help.aliyun.com/zh/functioncompute/sandbox-public-url

Python equivalent that starts a background HTTP server, gets the host for port 8000 via sandbox.get_host, prints the URL, and kills the process. Use background commands for long-running services and save the PID.

```python
handle = sandbox.commands.run(
    "python3 -m http.server 8000",
    background=True,
)

host = sandbox.get_host(8000)
url = f"https://{host}"

print(url)

sandbox.commands.kill(handle.pid)
```

--------------------------------

### GET /health

Source: https://help.aliyun.com/zh/functioncompute/browser-template

Health check endpoint to determine if the browser service has started successfully.

```APIDOC
## GET /health

### Description
Health check endpoint to determine if the browser service has started successfully.

### Method
GET

### Endpoint
`https://<sandbox-host>/health`

### Authentication
Requires `X-Access-Token` header.

### Response
#### Success Response (200)
- Service is up and running.

#### Error Response (403)
- Missing or invalid `X-Access-Token`.
```

--------------------------------

### 进入项目目录命令

Source: https://help.aliyun.com/zh/functioncompute/compile-and-deploy-code-packages-1-2

执行 `cd start-fc3-dotnetcore` 命令进入项目目录，该目录结构包含 HelloFcApp 子目录、readme 文件和 s.yaml 配置文件。

```bash
cd start-fc3-dotnetcore
```

--------------------------------

### Initialize Go Module and Install SDK

Source: https://help.aliyun.com/zh/functioncompute/build-a-custom-image-template

Commands to initialize a Go module named pop-template-demo and fetch the fcsandbox-20260509 SDK.

```shell
go mod init pop-template-demo
go get github.com/alibabacloud-go/fcsandbox-20260509
```

--------------------------------

### Get DevPod proxy address

Source: https://help.aliyun.com/zh/functioncompute/deepseek-ocr-model-deployment-best-practices

Example of a DevPod proxy URL used for remote debugging, with the path /proxy/8000/.

```bash
https://devpod-e***a-lwt***jyw.cn-hangzhou.ide.fc.aliyun.com/proxy/8000/
```

--------------------------------

### Install Go SDK and set module replacement

Source: https://help.aliyun.com/zh/functioncompute/e2b-sdk-java-and-go

Clone the e2b-go-sdk repository and replace the old module path with a local directory. Requires Go 1.22 or higher.

```bash
# 在包含 myapp/ 的目录中执行。
git clone https://github.com/aliyun-fc/e2b-go-sdk.git
cd myapp
go mod init myapp  # 如果已有 go.mod，请跳过此命令。
go mod edit -replace=github.com/e2b-dev/e2b-go-sdk=../e2b-go-sdk
```

--------------------------------

### TypeScript: Start HTTP server and get public host

Source: https://help.aliyun.com/zh/functioncompute/overview-3

Starts a Python HTTP server in the sandbox in the background, retrieves the public host using sandbox.getHost(8000), logs the HTTPS URL, and kills the server process.

```typescript
const server = await sandbox.commands.run("python3 -m http.server 8000", {
  background: true,
});

const host = sandbox.getHost(8000);
console.log(`https://${host}`);

await sandbox.commands.kill(server.pid);
```

--------------------------------

### Create template with second-generation runtime (Go)

Source: https://help.aliyun.com/zh/functioncompute/build-a-custom-image-template

Uses the fcsandbox20260509 client to create a template with a second-generation runtime. Sets CPU, memory, disk size, and sandbox configuration including the image, start command, and ready command. The start command runs during build and is persisted to the template snapshot; the ready command must exit with code 0 once to be considered ready. Panics on error.

```go
created, err := popClient.CreateTemplate(&fcsandbox20260509.CreateTemplateRequest{
    Body: &fcsandbox20260509.CreateTemplateInput{
        Name:   tea.String(fmt.Sprintf("pop-demo-gen2-%d", time.Now().Unix())),
        TeamID: tea.String(teamID),
        RuntimeConfig: &fcsandbox20260509.CreateTemplateRuntimeConfig{
            Cpu:        tea.Float32(2),
            MemorySize: tea.Int32(2048),
            DiskSize:   tea.Int32(15360),
            SandboxConfig: &fcsandbox20260509.CreateTemplateSandboxConfig{
                Image: tea.String("test-registry-vpc.cn-beijing.cr.aliyuncs.com/runtime/python:3.12-v1"),
                // 使用第二代运行时。
                Generation: tea.Int32(2),
                // 启动命令在构建期执行并就绪后固化到模板快照。
                StartCommand: tea.String("python3 -m http.server 8000"),
                // 就绪命令退出码为 0 一次即判定就绪。
                ReadyCommand: tea.String("curl -sf http://localhost:8000/ > /dev/null"),
            },
        },
    },
})
if err != nil {
    panic(err)
}
```

--------------------------------

### Error: Function instance exited unexpectedly (code 1) with start command 'npm run start' and Node.js log

Source: https://help.aliyun.com/zh/functioncompute/troubleshooting-2

Example error message and log when the Node.js script file is missing, showing exit code 1 and the module not found error.

```nodejs
Function instance exited unexpectedly(code 1, message:operation not permitted) with start command 'npm run start '.
Logs:> nodejs-express@0.0.0 start /code
> node ./not_exist_file.js

internal/modules/cjs/loader.js:905
  throw err;
  ^

Error: Cannot find module '/code/not_exist_file.js'
    at Function.Module._resolveFilename (internal/modules/cjs/loader.js:902:15)
    at Function.Module._load (internal/modules/cjs/loader.js:746:27)
    at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:75:12)
    at internal/main/run_main_module.js:17:47 {
  code: 'MODULE_NOT_FOUND',
  requireStack: []
}
npm ERR! code ELIFECYCLE
npm ERR! errno 1
 ERR! nodejs-express@0.0.0 start: `node ./not_exist_file.js`
 npm ERR!
 ERR! Failed at the nodejs-express@0.0.0 start script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     /root/.npm/_logs/2022-10-31T08_02_29_434Z-debug.log
```

--------------------------------

### Go SDK example for session lifecycle management

Source: https://help.aliyun.com/zh/functioncompute/function-session-lifecycle-management

Complete Go example using the FC 2023-03-30 SDK to create, invoke, update, get, and delete a session resource. It sets up the client with AccessKey and endpoint, then calls each session API in sequence. The example uses the 'x-affinity-header-v1' header for session invocation and shows configurable TTL and idle timeout values.

```go
package main

import (
	"fmt"

	openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
	fc20230330 "github.com/alibabacloud-go/fc-20230330/v4/client"
	util "github.com/alibabacloud-go/tea-utils/v2/service"
	"github.com/alibabacloud-go/tea/tea"
)

func main() {
	config := &openapi.Config{
		AccessKeyId:     tea.String("xxx"), // 配置 akid 信息
		AccessKeySecret: tea.String("xxx"), // 配置 ak secret 信息
		Protocol:        tea.String("http"),
		Endpoint:        tea.String("xxx"), // 配置 endpoint 信息
	}
	fcClient, err := fc20230330.NewClient(config)
	if err != nil {
		panic(err)
	}

	funcName := "test-session-function1"
	qualifier := "LATEST"
	sessionID, err := createSession(fcClient, funcName, qualifier)
	if err != nil {
		panic(err)
	}

	err = invokeFunctionWithSession(fcClient, funcName, qualifier, sessionID)
	if err != nil {
		panic(err)
	}

	err = updateSession(fcClient, funcName, sessionID, qualifier)
	if err != nil {
		panic(err)
	}

	err = getSession(fcClient, funcName, sessionID, qualifier)
	if err != nil {
		panic(err)
	}

	err = deleteSession(fcClient, funcName, sessionID, qualifier)
	if err != nil {
		panic(err)
	}
	return
}

// 创建 Session 资源
func createSession(fcClient *fc20230330.Client, functionName string, qualifier string) (string, error) {
	body := fc20230330.CreateSessionInput{
		SessionTTLInSeconds:         tea.Int64(21500), // 时间可自定义
		SessionIdleTimeoutInSeconds: tea.Int64(2000),  // 时间可自定义
	}
	req := fc20230330.CreateSessionRequest{
		Body:      &body,
		Qualifier: tea.String(qualifier),
	}

	resp, err := fcClient.CreateSession(&functionName, &req)
	if err != nil {
		return "", err
	}
	fmt.Printf("create session success %+v \n", resp.Body.String())
	return *resp.Body.SessionId, nil
}

// 请求会话
func invokeFunctionWithSession(fcClient *fc20230330.Client, functionName string, qualifier string, sessionId string) error {
	commonHeaders := map[string]*string{
		"x-affinity-header-v1": tea.String(sessionId), // key 需和创建函数时指定的 Header Field 一致。
	}
	header := &fc20230330.InvokeFunctionHeaders{
		CommonHeaders: commonHeaders,
	}
	invokeReq := &fc20230330.InvokeFunctionRequest{
		Qualifier: tea.String(qualifier),
	}
	_, err := fcClient.InvokeFunctionWithOptions(tea.String(functionName), invokeReq, header, &util.RuntimeOptions{})
	return err
}

// 更新 Session 资源
func updateSession(fcClient *fc20230330.Client, functionName string, sessionId string, qualifier string) error {
	body := fc20230330.UpdateSessionInput{
		SessionTTLInSeconds:         tea.Int64(21501), // 时间可更新
		SessionIdleTimeoutInSeconds: tea.Int64(2001),  // 时间可更新
	}

	req := fc20230330.UpdateSessionRequest{
		Body:      &body,
		Qualifier: tea.String(qualifier),
	}

	resp, err := fcClient.UpdateSession(&functionName, &sessionId, &req)
	if err != nil {
		return err
	}
	fmt.Printf("update session success %+v\n ", resp.Body.String())
	return nil
}

// 获取 Session 资源
func getSession(fcClient *fc20230330.Client, functionName string, sessionId string, qualifier string) error {
	req := &fc20230330.GetSessionRequest{}
	if qualifier != "" {
		req.Qualifier = tea.String(qualifier)
	}
	getSession, err := fcClient.GetSession(tea.String(functionName), tea.String(sessionId), req)
	if err != nil {
		return err
	}
	fmt.Printf("get session success %+v ", getSession.Body.String())
	return nil
}

// 删除 Session 资源
func deleteSession(fcClient *fc20230330.Client, functionName string, sessionId string, qualifier string) error {
	req := fc20230330.DeleteSessionRequest{
		Qualifier: tea.String(qualifier),
	}
	resp, err := fcClient.DeleteSession(&functionName, &sessionId, &req)
	if err != nil {
		return err
	}
	fmt.Printf("delete session success %+v\n ", *resp.StatusCode)
	return nil
}
```

--------------------------------

### Install Alibaba Cloud Signature SDKs

Source: https://help.aliyun.com/zh/functioncompute/configure-signature-authentication-for-http-triggers

Quick installation commands for the signature SDKs in Golang, Python, Node.js, and Java. Use the appropriate command for your language to install the required SDK.

```bash
go get github.com/alibabacloud-go/openapi-util/service
```

```bash
pip install alibabacloud-openapi-util
```

```bash
npm install @alicloud/openapi-util
```

```xml
<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>openapiutil</artifactId>
  <version>0.2.1</version>
</dependency>
<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>tea-openapi</artifactId>
  <version>0.3.1</version>
</dependency>
```

--------------------------------

### 初始化Python函数项目

Source: https://help.aliyun.com/zh/functioncompute/install-serverless-devs-and-docker-1

使用sudo s init start-fc3-python创建Python语言的Hello World项目，执行后输出交互提示和下载信息。成功初始化后生成start-fc3-python文件夹，包含s.yaml、code和readme.md文件。

```shell
sudo s init start-fc3-python
```

```plaintext
   More applications: https://registry.serverless-devs.com
? Please input your project name (init dir) start-fc3-python
Downloading[/v3/packages/start-fc3-python/zipball/0.0.8]...
Download start-fc3-python successfully

...
创建应用所在的地区
? 地域 cn-huhehaote
只能包含字母、数字、下划线和中划线。不能以数字、中划线开头。长度在 1-128 之间。
? 函数名称 start-python-8i32
创建应用所在的地区
? python 运行时 python3.9
? please select credential alias default

    * Before using, please check whether the actions command in Yaml file is available
    * Carefully reading the notes in s.yaml is helpful for the use of the tool
    * If need help in the use process, please apply to join the Dingtalk Group: 33947367


   Thanks for using Serverless-Devs
   You could [cd /start-fc3-python] and enjoy your serverless journey!
   If you need help for this example, you can use [s -h] after you enter folder.
   Document ❤ Star: https://github.com/Serverless-Devs/Serverless-Devs
   More applications: https://registry.serverless-devs.com
```

```shell
cd start-fc3-python
```

--------------------------------

### Node.js request example for signed HTTP trigger

Source: https://help.aliyun.com/zh/functioncompute/configure-signature-authentication-for-http-triggers

Node.js example that generates a signature using the @alicloud/openapi-util SDK and sends a POST request to an HTTP trigger. Requires environment variables ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET; optionally ALIBABA_CLOUD_SECURITY_TOKEN for STS. The method must be uppercase; change axios.post to axios.get for GET requests.

```nodejs
const util = require("@alicloud/openapi-util");
const axios = require('axios');

async function main() {
    const accessKeyId = process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'];
    const accessKeySecret = process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'];
    const securityToken = process.env['ALIBABA_CLOUD_SECURITY_TOKEN'] || ''; // 可选，使用STS时需要提供
    
    //method参数请求方式要求必须大写，如：POST、GET，如果您的请求方式为GET，需要将下方axios.post改为axios.get
    const method = 'POST';
    const body = 'hello world';
    const url = 'https://xx.cn-shanghai.fcapp.run/hello?foo=bar' // 你的HTTP触发器地址
    const date = new Date().toISOString();
    let headers = {
        'x-acs-date': date,
        'x-acs-security-token': securityToken
    };

    const parsedUrl = new URL(url);
    const authRequest = {
        method: method,
        pathname: parsedUrl.pathname.replace('$', '%24'),
        headers: headers,
        query: Object.fromEntries(parsedUrl.searchParams),
    };
    console.log('auth: ', authRequest);
    const auth = util.default.getAuthorization(authRequest, 'ACS3-HMAC-SHA256', '', accessKeyId, accessKeySecret);
    headers['authorization'] = auth;
    
    //如果method请求方式为GET，需要将下方axios.post改为axios.get
    const resp = await axios.post(url, body, {
        headers: headers,
    });
    console.log('resp: ', resp.data);
}

main().catch(console.error);
```

--------------------------------

### Get Remaining Execution Time Using deadline in Go

Source: https://help.aliyun.com/zh/functioncompute/context-5

This example demonstrates how to use the deadline from the context to get the remaining execution time of a function. It retrieves the deadline, subtracts 100 milliseconds as a buffer, and uses a select loop with a timeout channel to perform work until the deadline approaches, returning a message when finished before timing out.

```go
package main

import (
    "context"
    "fmt"
    "log"
    "time"

    "github.com/aliyun/fc-runtime-go-sdk/fc"
)

func LongRunningHandler(ctx context.Context) (string, error) {
    deadline, _ := ctx.Deadline()
    fmt.Printf("now: %s\ndeadline: %s\n", time.Now().String(), deadline.String())
    deadline = deadline.Add(-100 * time.Millisecond)
    timeoutChannel := time.After(time.Until(deadline))

    for {
        select {
        case <-timeoutChannel:
            return "Finished before timing out.", nil
        default:
            log.Print("hello!")
            time.Sleep(50 * time.Millisecond)
        }
    }
}

func main() {
    fc.Start(LongRunningHandler)
}
```

--------------------------------

### Run main.go

Source: https://help.aliyun.com/zh/functioncompute/configure-signature-authentication-for-http-triggers

Execute the Go program to test the signature authentication.

```bash
go run main.go
```
Tokens:
Raw