更新时间:2025-07-31 GMT+08:00
分享

导入函数

功能介绍

导入函数

调用方法

请参见如何调用API

URI

POST /v2/{project_id}/fgs/functions/import

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

租户项目 ID,获取方式请参见获取项目ID

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

Content-Type

String

参数解释:

消息体的类型(格式)。

约束限制:

不涉及。

取值范围:

只能为application/json

默认取值:

application/json

表3 请求Body参数

参数

是否必选

参数类型

描述

func_name

String

参数解释

导入的函数的函数名。

约束限制

需要先执行函数导出。

取值范围

可包含字母、数字、下划线和中划线,以大/小写字母开头,以字母或数字结尾,长度不超过60个字符。

默认取值

不涉及。

file_name

String

参数解释

函数导出时生成的文件名,一般是以导出函数命名,后缀位.zip。

约束限制

需要先执行函数导出。

取值范围

大小不能超过300M。

默认取值

不涉及

file_type

String

参数解释

导入包的文件类型。

约束限制

需要先执行函数导出。

取值范围

当前仅支持zip。

默认取值

zip。

file_code

String

参数解释

函数代码。代码必须要进行base64编码。

约束限制

需要先执行函数导出。

取值范围

不涉及。

默认取值

不涉及。

package

String

参数解释

导出函数所在的应用名称。

约束限制

需要先执行函数导出。

取值范围

可包括字母、数字、下划线。

默认取值

default。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

func_urn

String

参数解释:

函数的URN(Uniform Resource Name),唯一标识函数。

取值范围:

不涉及。

func_name

String

参数解释:

函数名称。

取值范围

不涉及。

domain_id

String

参数解释

租户账号id。

取值范围

不涉及。

namespace

String

参数解释

租户的project id。

取值范围

不涉及。

project_name

String

参数解释:

租户的project name。

取值范围:

不涉及。

package

String

参数解释:

函数所属的分组Package,用于用户针对函数的自定义分组。

取值范围:

不涉及。

runtime

String

参数解释

FunctionGraph函数的运行时,即函数执行环境。

取值范围

  • Java8: Java 8

  • Java11: Java 11

  • Java17: Java 17

  • Java21: Java 21

  • Python2.7: Python 2.7

  • Python3.6: Python 3.6

  • Python3.9: Python 3.9

  • Python3.10: Python 3.10

  • Python3.12: Python 3.12

  • Go1.x: Go 1.x

  • Node.js6.10: Nodejs 6.10

  • Node.js8.10: Nodejs 8.10

  • Node.js10.16: Nodejs 10.16

  • Node.js12.13: Nodejs 12.13

  • Node.js14.18: Nodejs 14.18

  • Node.js16.17: Nodejs 16.17

  • Node.js18.15: Nodejs 18.15

  • Node.js20.15: Nodejs 20.15

  • C#(.NET Core 2.1): C# 2.1

  • C#(.NET Core 3.1): C# 3.1

  • C#(.NET Core 6.0): C# 6.0

  • C#(.NET Core 8.0): C# 8.0

  • Custom: 定制运行时

  • PHP7.3: Php 7.3

  • PHP8.3: Php 8.3

  • Cangjie1.0:仓颉1.0版本

  • Cangjie0.52.3:仓颉0.52.3版本

  • http: HTTP函数

  • Custom Image: 自定义镜像函数

timeout

Integer

参数解释:

函数执行超时时间,超时函数将被强行停止,

取值范围:

范围3~259200秒。

handler

String

参数解释

函数执行入口

规则:xx.xx,必须包含“. ”;自定义镜像函数handler为“-”

举例:对于node.js函数:myfunction.handler,则表示函数的文件名为myfunction.js,执行的入口函数名为handler。长度不超过128个字符。

取值范围:

最小长度为3,最大长度128字符

memory_size

Integer

参数解释:

函数消耗的内存,单位MB。

取值范围

  • 128

  • 256

  • 512

  • 768

  • 1024

  • 1280

  • 1536

  • 1792

  • 2048

  • 2560

  • 3072

  • 3584

  • 4096

gpu_memory

Integer

参数解释:

函数消耗的显存,只支持自定义运行时与自定义镜像函数配置GPU,单位MB。

取值范围

  • 1024

  • 2048

  • 3072

  • 4096

  • 5120

  • 6144

  • 7168

  • 8192

  • 9216

  • 10240

  • 11264

  • 12288

  • 13312

  • 14336

  • 15360

  • 16384

cpu

Integer

参数解释:

函数占用的cpu资源。

单位为millicore(1 core=1000 millicores)。

取值与MemorySize成比例,默认是128M内存占0.1个核(100 millicores)。

取值范围:

不涉及。

code_type

String

参数解释:

函数代码类型

取值范围:

取值有5种。

  • inline: UI在线编辑代码。

  • zip: 函数代码为zip包。

  • obs: 函数代码来源于obs存储。

  • jar: 函数代码为jar包,主要针对Java函数。

  • Custom-Image-Swr: 函数代码来源与SWR自定义镜像。

code_url

String

参数解释:

当CodeType为obs时,该值为函数代码包在OBS上的地址,CodeType为其他值时,该字段为空。

取值范围:

obs链接地址。

code_filename

String

参数解释:

函数的文件名,当CodeType为jar/zip时必须提供该字段,inline和obs不需要提供。

取值范围:

不涉及。

code_size

Long

参数解释:

函数大小,单位:字节。

取值范围:

不涉及。

user_data

String

参数解释:

用户自定义的name/value信息。 在函数中使用的参数。 举例:如函数要访问某个主机,可以设置自定义参数:Host={host_ip},总长度不超过4KB。

取值范围:

json格式的字符串

digest

String

参数解释

函数代码SHA512 hash值,用于判断函数是否变化。

取值范围:

不涉及。

version

String

参数解释

函数版本号,由系统自动生成,规则:vYYYYMMDD-HHMMSS(v+年月日-时分秒)。

取值范围:

不涉及。

image_name

String

参数解释:

函数版本的内部标识。

取值范围:

不涉及。

xrole

String

参数解释:

函数配置委托。需要IAM支持,并在IAM界面创建委托,当函数需要访问其他服务时,必须提供该字段。配置后用户可以通过函数执行入口方法中的context参数获取具有委托中权限的token、ak、sk,用于访问其他云服务。如果用户函数不访问任何云服务,则不用提供委托名称。

取值范围:

不涉及。

app_xrole

String

参数解释:

函数执行委托。可为函数执行单独配置执行委托,这将减小不必要的性能损耗;不单独配置执行委托时,函数执行和函数配置将使用同一委托。

取值范围:

不涉及。

description

String

参数解释:

函数描述。

取值范围:

不涉及。

version_description

String

参数解释

函数版本描述信息。

取值范围

不涉及。

last_modified

String

参数解释

函数最后一次更新时间。

取值范围

秒级时间戳。

func_vpc

FuncVpc object

参数解释

函数vpc配置。需同时为函数配置具有vpc权限的委托。

取值范围

不涉及。

depend_list

Array of strings

参数解释

依赖id列表

取值范围:

不涉及。

depend_version_list

Array of strings

参数解释

依赖版本id列表

取值范围:

不涉及。

strategy_config

StrategyConfig object

参数解释

函数策略配置。

取值范围:

不涉及。

status

Integer

参数解释:

函数状态。

取值范围:

  • 0: 函数启用状态。

  • 1: 函数禁用状态。

extend_config

String

参数解释

函数扩展配置,废弃字段。

取值范围

不涉及。

initializer_handler

String

参数解释:

函数初始化入口,规则:xx.xx,必须包含“. ”。当配置初始化函数时,此参数必填。

举例:对于node.js函数:myfunction.initializer,则表示函数的文件名为myfunction.js,初始化的入口函数名为initializer。

取值范围:

不涉及。

initializer_timeout

Integer

参数解释:

初始化超时时间,超时函数将被强行停止。当配置初始化函数时,此参数必填。

取值范围:

1-300秒。

pre_stop_handler

String

函数预停止函数的入口,规则:xx.xx,必须包含“. ”。

举例:对于node.js函数:myfunction.pre_stop_handler,则表示函数的文件名为myfunction.js,初始化的入口函数名为pre_stop_handler。

pre_stop_timeout

Integer

参数解释:

初始化超时时间,超时函数将被强行停止。

取值范围:

1~90秒。

enterprise_project_id

String

参数解释:

企业项目ID,在企业用户创建函数时必填。

取值范围:

不涉及。

表5 FuncVpc

参数

参数类型

描述

domain_id

String

参数解释

租户账号id。

取值范围

不涉及。

namespace

String

参数解释

租户的project id。

取值范围

不涉及。

vpc_name

String

参数解释

虚拟私有云名称。

取值范围

不涉及。

vpc_id

String

参数解释

虚拟私有云唯一标识。

取值范围

不涉及。

subnet_name

String

参数解释

子网名称。

取值范围

不涉及。

subnet_id

String

参数解释

子网编号。

取值范围

不涉及。

cidr

String

参数解释

子网掩码。

取值范围

不涉及。

gateway

String

参数解释

网关。

取值范围

不涉及。

security_groups

Array of strings

参数解释

安全组。

取值范围

字符串列表。

is_safety

Boolean

参数解释

是否开启安全访问。开启时,需要您自行配置VPCEP网络但可以提供更安全的VPC连接访问并打通内网域名。注意:开启后无法关闭。

取值范围

  • true:开启

  • false:关闭

表6 StrategyConfig

参数

参数类型

描述

concurrency

Integer

参数解释

单函数最大实例数,-1代表该函数实例数无限制。

取值范围

  • v1版本:0和-1

  • v2版本:[-1, 1000]

concurrent_num

Integer

参数解释

单实例并发数, v2版本支持。

取值范围

[1, 1000]

状态码: 409

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

导入函数,文件名为"test.zip",类型为zip,文件base64编码为"xxx"。

POST https://{Endpoint}/v2/{project_id}/fgs/functions/import

{
  "func_name" : "test",
  "file_name" : "test.zip",
  "file_type" : "zip",
  "file_code" : "xxxxxxxxxxxxxxxxxxxxx"
}

响应示例

状态码: 200

ok

{
  "func_urn" : "urn:fss:{region}:46b6f338fc3445b8846c71dfb1fbxxxx:function:default:test_v1_2",
  "func_name" : "test_v1_2",
  "domain_id" : "14ee2e35****a7998b******aa24cabf",
  "namespace" : "46b6f338fc3445b8846c71dfb1fbxxxx",
  "project_name" : "{region}",
  "package" : "default",
  "runtime" : "Node.js6.10",
  "timeout" : 3,
  "handler" : "index.handler",
  "memory_size" : 128,
  "cpu" : 300,
  "code_type" : "zip",
  "code_filename" : "index.zip",
  "code_size" : 6709,
  "digest" : "faa825575c45437cddd4e369bea69893bcbe195d478178462ad90984fe72993f3f59d15f41c5373f807f3e05fb9af322c55dabeb16565c386e402413458e6068",
  "version" : "latest",
  "image_name" : "latest-191025153727@zehht",
  "last_modified" : "2019-10-25 15:37:27",
  "status" : 0,
  "strategy_config" : {
    "concurrency" : -1
  },
  "enterprise_project_id" : "46b6f338fc3445b8846c71dfb1fbxxxx"
}

状态码: 409

Conflict

{
  "error_code" : "FSS.1061",
  "error_msg" : "The function has existed"
}

SDK代码示例

SDK代码示例如下。

Java

导入函数,文件名为"test.zip",类型为zip,文件base64编码为"xxx"。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.functiongraph.v2.region.FunctionGraphRegion;
import com.huaweicloud.sdk.functiongraph.v2.*;
import com.huaweicloud.sdk.functiongraph.v2.model.*;


public class ImportFunctionSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        FunctionGraphClient client = FunctionGraphClient.newBuilder()
                .withCredential(auth)
                .withRegion(FunctionGraphRegion.valueOf("<YOUR REGION>"))
                .build();
        ImportFunctionRequest request = new ImportFunctionRequest();
        ImportFunctionRequestBody body = new ImportFunctionRequestBody();
        body.withFileCode("xxxxxxxxxxxxxxxxxxxxx");
        body.withFileType("zip");
        body.withFileName("test.zip");
        body.withFuncName("test");
        request.withBody(body);
        try {
            ImportFunctionResponse response = client.importFunction(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

导入函数,文件名为"test.zip",类型为zip,文件base64编码为"xxx"。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkfunctiongraph.v2.region.functiongraph_region import FunctionGraphRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkfunctiongraph.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = FunctionGraphClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(FunctionGraphRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ImportFunctionRequest()
        request.body = ImportFunctionRequestBody(
            file_code="xxxxxxxxxxxxxxxxxxxxx"
            file_type="zip"
            file_name="test.zip"
            func_name="test"
        )
        response = client.import_function(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

导入函数,文件名为"test.zip",类型为zip,文件base64编码为"xxx"。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    functiongraph "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/functiongraph/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/functiongraph/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/functiongraph/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := functiongraph.NewFunctionGraphClient(
        functiongraph.FunctionGraphClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ImportFunctionRequest{}
	request.Body = &model.ImportFunctionRequestBody{
		FileCode: "xxxxxxxxxxxxxxxxxxxxx"
		FileType: "zip"
		FileName: "test.zip"
		FuncName: "test"
	}
	response err := client.ImportFunction(request)
	if err == nil {
        fmt.Printf("%+v\n" response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

ok

409

Conflict

500

Internal Server Error 服务内部错误。

错误码

请参见错误码

相关文档