CreateFunction--函数服务-火山引擎

文档中心

立即注册

导航

CreateFunction

最近更新时间：2025.01.07 10:41:16首次发布时间：2024.07.08 11:32:09

创建函数，包含函数配置及函数代码。

请求说明

请求方式：POST
请求地址：http://open.volcengineapi.com/?Action=CreateFunction&Version=2024-06-06

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	CreateFunction	接口名称。当前 API 的名称为 `CreateFunction`。
Version	String	是	2024-06-06	接口版本。当前 API 的版本为 `2024-06-06`。
Name	String	是	official-site	函数名称。同一个账号内，函数名称必须唯一。支持大小写英文字母、数字、中划线（-）、下划线(_)，长度限制为 4~64 个字符。
Description	String	否	轻量级官网	函数描述。长度限制为 1000 以内的 Unicode 字符。
Runtime	String	是	python3.8/v1	函数运行时，取值： golang/v1 native/v1 nativejava8/v1 node14/v1 node20/v1 nodeprime14/v1 python3.12/v1 python3.8/v1 python3.9/v1 说明当`SourceType = image`时，Runtime 必须为`native/v1`。
ExclusiveMode	Boolean	否	false	独占模式开关。取值： true：关闭单实例多并发，即同一时刻单实例只能处理一个请求的独占模式。 false：（默认值）开启单实例多并发，即同一时刻单实例可处理多个请求的非独占模式，可通过 MaxConcurrency 设置单实例能够承载的最大并发请求数量。
RequestTimeout	Integer	否	30	请求超时时间。单位：秒。取值范围：1~900。默认值：30。
MaxConcurrency	Integer	否	100	单实例最大并发。`ExclusiveMode = false`时生效。取值范围：10~1000。默认直：100。
MemoryMB	Integer	否	1024	单实例最大内存。单位：MiB。取值范围：512~4096。说明取值以 512 为梯度。默认值：1024。
SourceType	String	否	tos	代码来源类型，取值： tos：火山引擎对象存储（TOS）。 zip：本地压缩文件。 image：火山引擎镜像仓库（CR），支持基础版和企业版。
Source	String	否	pqyqo9qa/3kwem******.zip	代码来源，取值： zip：Base64 编码后的二进制 ZIP 文件。 tos：格式为`bucket_name:object_key`的字符串，例如： `vefaas-test:vefaas-python38-default.zip`。 image：格式为`host/namespace/repo:tag`的镜像地址。例如：`cp-enterprise-cn-beijing.cr.volces.com/demo/nginx:latest`。
Envs	Array of EnvVar	否	-	环境变量。
VpcConfig	Object of VpcConfig	否	-	私有网络（VPC）配置。
TlsConfig	Object of TlsConfig	否	-	日志服务（TLS）相关配置。
SourceAccessConfig	Object of SourceAccessConfig	否	-	镜像仓库的访问配置。注意设置跨账号的自定义镜像时，需要提供访问配置。
NasStorage	Object of NasStorage	否	-	文件存储（NAS）挂载配置。
TosMountConfig	Object of TosMountConfig	否	-	对象存储（TOS）挂载配置。
InitializerSec	Integer	否	30	函数初始化超时配置。
Command	String	否	./run.sh	实例的自定义启动命令（目前只支持 native/v1 运行时）。
CpuStrategy	String	否	always	函数 CPU 计费策略，当创建微服务应用类型的函数时，该字段必须设置为 `always`，表示至少有一个实例在运行。
ProjectName	String	否	default	函数关联的项目名称。

EnvVar

参数	类型	是否必选	示例值	描述
Key	String	是	business_type	环境变量的 Key。1 ~ 63 个字符，字符中可包含英文、数字以及下划线（_），并且不能以数字开头。同一函数下 Key 唯一。
Value	String	是	free	环境变量的值。

VpcConfig

参数	类型	是否必选	示例值	描述
VpcId	String	否	vpc-3rf8******	VPC ID。如果 VPC ID 为空字符串，代表删除当前 VPC 配置。
EnableVpc	Boolean	是	false	函数是否开启私有网络访问。
SubnetIds	Array of String	否	subnet-mj1l******	子网 ID。
SecurityGroupIds	Array of String	否	sg-rs6s******	安全组 ID。
EnableSharedInternetAccess	Boolean	否	false	函数访问公网开关。是否通过 veFaaS 的 VPC 共享 NAT 网关，访问公网。取值： true：开启，通过默认网卡访问公网。会产生公网出流量费用。 false：关闭，函数无法通过默认网卡访问公网。

TlsConfig

参数	类型	是否必选	示例值	描述
EnableLog	Boolean	是	false	TLS 日志功能开关。 true：开启，函数的 stdout/stderr 日志将被采集至日志服务的指定日志项目和日志主题中。 false：关闭，不采集日志。
TlsTopicId	String	否	tls-vefaas-logstore	TLS 日志主题 ID。
TlsProjectId	String	否	tls-vefaas	TLS 日志项目 ID。

参数

类型

是否必选

示例值

描述

EnableLog

Boolean

是

false

TLS 日志功能开关。

true：开启，函数的 stdout/stderr 日志将被采集至日志服务的指定日志项目和日志主题中。
false：关闭，不采集日志。

TlsTopicId

String

否

tls-vefaas-logstore

TLS 日志主题 ID。

TlsProjectId

String

否

tls-vefaas

TLS 日志项目 ID。

SourceAccessConfig

参数	类型	是否必选	示例值	描述
Password	String	是	password	镜像仓库密码。
Username	String	是	operator	镜像仓库用户名。

NasStorage

参数	类型	是否必选	示例值	描述
EnableNas	Boolean	是	false	是否开启 NAS 存储挂载。 true：开启，将数据存储至 NAS。 false：不开启。
NasConfigs	Array of NasConfig	否	-	NAS 存储配置。

参数

类型

是否必选

示例值

描述

EnableNas

Boolean

是

false

是否开启 NAS 存储挂载。

true：开启，将数据存储至 NAS。
false：不开启。

NasConfigs

Array of NasConfig

否

NAS 存储配置。

TosMountConfig

参数	类型	是否必选	示例值	描述
EnableTos	Boolean	是	false	是否开启 TOS 存储挂载。
Credentials	Object of Credentials	否	-	开启 TOS 后需要提供具有 TOS 域名访问权限的 AKSK。
MountPoints	Array of TosMountPoint	否	-	开启 TOS 后需要提供 TOS 存储配置列表，最多不超过 5 个。

NasConfig

参数	类型	是否必选	示例值	描述
Gid	Long	否	1000	文件系统中的用户组，暂时不支持自定义，如果提供该参数，参数值 1000（和函数 run user gid 保持一致）。
Uid	Long	否	1000	文件系统中的用户，暂时不支持自定义，如果提供该参数，参数值只能为 1000（和函数 run user uid 保持一致）。
RemotePath	String	是	/	文件系统远端目录。长度 1-128 个字符，只能以“/”开头，支持大小写字母、数字和特殊字符（- . _ ~ / : @ = + ? # ）。
FileSystemId	String	是	enas-cns******	NAS 文件系统 ID。
MountPointId	String	是	mount-63******	NAS 挂载点 ID。
LocalMountPath	String	是	/mnt/nas	函数本地挂载目录。长度 1-128 个字符，只能以“/”开头，支持大小写字母、数字和特殊字符（- . _ ~ / : @ = + ? # ）。

Credentials

参数	类型	是否必选	示例值	描述
AccessKeyId	String	是	******	火山引擎账号的 AccessKey ID（AK）。获取方式，请参见访问密钥使用指南。
SecretAccessKey	String	是	******	火山引擎账号的 Secret Access Key（SK）。获取方式，请参见访问密钥使用指南。

TosMountPoint

参数	类型	是否必选	示例值	描述
Endpoint	String	是	http://tos-cn-beijing.ivolces.com	TOS 访问域名。
ReadOnly	Boolean	否	true	函数本地目录访问权限，挂载 TOS Bucket后，函数本地挂载目录的访问权限是否为只读。 true：只读 false（默认）：读写
BucketName	String	是	ai-model	TOS 存储桶。
BucketPath	String	是	/	挂载的 TOS Bucket 路径。
LocalMountPath	String	是	/mnt/tos	函数本地挂载目录。

请求示例

POST http://open.volcengineapi.com/?Action=CreateFunction&Version=2024-06-06 HTTP/1.1
Content-Type: application/json
{
    "Name": "official-site",
    "Description": "轻量级官网",
    "Runtime": "python3.8/v1",
    "ExclusiveMode": true,
    "RequestTimeout": 30,
    "MaxConcurrency": 100,
    "MemoryMB": 1024,
    "SourceType": "tos",
    "Source": "pqyqo9qa/3kwem******.zip",
    "Envs": [
        {
            "Key": "business_type",
            "Value": "free"
        }
    ],
    "VpcConfig": {
        "VpcId": "vpc-3rf8******",
        "EnableVpc": true,
        "SubnetIds": [
            ""
        ],
        "SecurityGroupIds": [
            ""
        ],
        "EnableSharedInternetAccess": true
    },
    "TlsConfig": {
        "EnableLog": true,
        "TlsTopicId": "tls-vefaas-logstore",
        "TlsProjectId": "tls-vefaas"
    },
    "SourceAccessConfig": {
        "Password": "Feie&ffe123huabcd",
        "Username": "operator"
    },
    "NasStorage": {
        "EnableNas": true,
        "NasConfigs": [
            {
                "Gid": 1000,
                "Uid": 1000,
                "RemotePath": "/",
                "FileSystemId": "enas-cns******",
                "MountPointId": "mount-63******",
                "LocalMountPath": "/mnt/nas"
            }
        ]
    },
    "TosMountConfig": {
        "EnableTos": true,
        "Credentials": {
            "AccessKeyId": "******",
            "SecretAccessKey": "******"
        },
        "MountPoints": [
            {
                "Endpoint": "http://tos-cn-beijing.ivolces.com",
                "ReadOnly": true,
                "BucketName": "ai-model",
                "BucketPath": "/",
                "LocalMountPath": "/mnt/tos"
            }
        ]
    },
    "InitializerSec": 30,
    "Command": "./run.sh",
    "CpuStrategy": "always",
    "ProjectName": "default"
}

返回参数

参数	类型	示例值	描述
Id	String	pqy******	函数 ID。
Name	String	official-site	函数名字。
Description	String	轻量级官网	函数描述。
Runtime	String	python3.8/v1	函数运行时。
ExclusiveMode	Boolean	false	独占模式开关。 true：关闭单实例多并发，即同一时刻单实例只能处理一个请求的独占模式。 false（默认）：开启单实例多并发，即同一时刻单实例可处理多个请求的非独占模式，可通过 MaxConcurrency 设置单实例能够承载的最大并发请求数量。
RequestTimeout	Integer	30	请求超时（单位秒）。
MaxConcurrency	Integer	100	单实例最大并发。
MemoryMB	Integer	1024	单实例最大内存（单位 MB）。
CodeSize	Integer	473	代码包大小（单位 MB）。
CodeSizeLimit	Integer	256	代码包大小上限。 SourceType=zip，CodeSizeLimit=15MB。 SourceType=tos，CodeSizeLimit=256MB。
SourceLocation	String	https://vefaas.tos-s3-cn.volces.com/template_dir/666ad75b9124c400072abcvefaas-python3.9-default.zip?X-Amz******	代码/镜像的来源地址。
SourceType	String	tos	代码来源类型，可选值有： tos：火山引擎对象存储 zip：本地压缩文件 image：火山引擎镜像仓库，支持基础版和企业版。
Envs	Array of EnvVar	-	函数环境变量。
VpcConfig	Object of VpcConfig	-	VPC 配置。
CreationTime	String	2024-06-14 15:31:07.143863441 +0800 CST m=+88714.902440864	创建时间。
LastUpdateTime	String	2024-06-14 15:31:07.143863491 +0800 CST m=+88714.902440914	更新时间。
TlsConfig	Object of TlsConfig	-	函数日志配置。
Owner	String	22******	函数所有者（账号 Id）。
TriggersCount	Integer	0	该函数的触发器个数。
InstanceType	String	nvidia-tesla-l4	函数实例的实例类型：空值：CPU 实例。非空值：GPU 实例。
NasStorage	Object of NasStorage	-	文件存储 NAS 挂载配置。
TosMountConfig	Object of TosMountConfig	-	对象存储 TOS 挂载配置。
InitializerSec	Integer	30	函数初始化超时配置。
Command	String	./run.sh	实例的自定义启动命令（目前只支持 native/v1 运行时）。
Port	Integer	8000	实例的自定义监听端口（目前只支持 native/v1 运行时）。
CpuStrategy	String	always	函数 CPU 计费策略，当微服务应用类型的函数时，该字段为 `always`，表示至少有一个实例在运行。
ProjectName	String	default	项目名称

EnvVar

参数	类型	示例值	描述
Key	String	business_type	环境变量的 Key。1 ~ 63 个字符，字符中可包含英文、数字以及下划线（_），并且不能以数字开头。同一函数下 Key 唯一。
Value	String	free	环境变量的值。

VpcConfig

参数	类型	示例值	描述
VpcId	String	vpc-3rf8******	VPC ID。如果 VPC ID 为空字符串，代表删除当前 VPC 配置。
EnableVpc	Boolean	false	函数是否开启私有网络访问。
SubnetIds	Array of String	subnet-mj1l******	子网 ID。
SecurityGroupIds	Array of String	sg-rs6s******	安全组 ID。
EnableSharedInternetAccess	Boolean	false	函数访问公网开关。是否通过 veFaaS 的 VPC 共享 NAT 网关，访问公网。取值： true：开启，通过默认网卡访问公网。会产生公网出流量费用。 false：关闭，函数无法通过默认网卡访问公网。

TlsConfig

参数	类型	示例值	描述
EnableLog	Boolean	false	TLS 日志功能开关。 true：开启，函数的 stdout/stderr 日志将被采集至日志服务的指定日志项目和日志主题中。 false：关闭，不采集日志。
TlsTopicId	String	tls-vefaas-logstore	TLS 日志主题 ID。
TlsProjectId	String	tls-vefaas	TLS 日志项目 ID。

参数

类型

示例值

描述

EnableLog

Boolean

false

TLS 日志功能开关。

true：开启，函数的 stdout/stderr 日志将被采集至日志服务的指定日志项目和日志主题中。
false：关闭，不采集日志。

TlsTopicId

String

tls-vefaas-logstore

TLS 日志主题 ID。

TlsProjectId

String

tls-vefaas

TLS 日志项目 ID。

NasStorage

参数	类型	示例值	描述
EnableNas	Boolean	false	是否开启 NAS 存储挂载。 true：开启，将数据存储至 NAS。 false：不开启。
NasConfigs	Array of NasConfig	-	NAS 存储配置。

参数

类型

示例值

描述

EnableNas

Boolean

false

是否开启 NAS 存储挂载。

true：开启，将数据存储至 NAS。
false：不开启。

NasConfigs

Array of NasConfig

NAS 存储配置。

TosMountConfig

参数	类型	示例值	描述
EnableTos	Boolean	false	是否开启 TOS 存储挂载。
Credentials	Object of Credentials	-	开启 TOS 后需要提供具有 TOS 域名访问权限的 AKSK。
MountPoints	Array of TosMountPoint	-	开启 TOS 后需要提供 TOS 存储配置列表，最多不超过 5 个。

NasConfig

参数	类型	示例值	描述
Gid	Long	1000	文件系统中的用户组，暂时不支持自定义，如果提供该参数，参数值 1000（和函数 run user gid 保持一致）。
Uid	Long	1000	文件系统中的用户，暂时不支持自定义，如果提供该参数，参数值只能为 1000（和函数 run user uid 保持一致）。
RemotePath	String	/	文件系统远端目录。长度 1-128 个字符，只能以“/”开头，支持大小写字母、数字和特殊字符（- . _ ~ / : @ = + ? # ）。
FileSystemId	String	enas-cns******	NAS 文件系统 ID。
MountPointId	String	mount-63******	NAS 挂载点 ID。
LocalMountPath	String	/mnt/nas	函数本地挂载目录。长度 1-128 个字符，只能以“/”开头，支持大小写字母、数字和特殊字符（- . _ ~ / : @ = + ? # ）。

Credentials

参数	类型	示例值	描述
AccessKeyId	String	******	火山引擎账号的 AccessKey ID（AK）。获取方式，请参见访问密钥使用指南。
SecretAccessKey	String	******	火山引擎账号的 Secret Access Key（SK）。获取方式，请参见访问密钥使用指南。

TosMountPoint

参数	类型	示例值	描述
Endpoint	String	http://tos-cn-beijing.ivolces.com	TOS 访问域名。
ReadOnly	Boolean	true	函数本地目录访问权限，挂载 TOS Bucket后，函数本地挂载目录的访问权限是否为只读。 true：只读 false（默认）：读写
BucketName	String	ai-model	TOS 存储桶。
BucketPath	String	/	挂载的 TOS Bucket 路径。
LocalMountPath	String	/mnt/tos	函数本地挂载目录。

返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CreateFunction",
        "Version": "2024-06-06",
        "Service": "vefaas",
        "Region": "cn-beijing"
    },
    "Result": {
        "Id": "pqyqo9qa",
        "Name": "official-site",
        "Description": "轻量级官网",
        "Runtime": "python3.8/v1",
        "ExclusiveMode": true,
        "RequestTimeout": 30,
        "MaxConcurrency": 100,
        "MemoryMB": 1024,
        "CodeSize": 473,
        "CodeSizeLimit": 256,
        "SourceLocation": "https://vefaas.tos-s3-cn.volces.com/template_dir/666ad75b9124c400072abcvefaas-python3.9-default.zip?X-Amz******",
        "SourceType": "tos",
        "Envs": [
            {
                "Key": "business_type",
                "Value": "free"
            }
        ],
        "VpcConfig": {
            "EnableVpc": true,
            "VpcId": "vpc-rrag******",
            "SubnetIds": [
                "subnet-milb******"
            ],
            "SecurityGroupIds": [
                "sg-rrag******"
            ],
            "EnableSharedInternetAccess": true
        },
        "CreationTime": "2024-06-14 15:31:07.143863441 +0800 CST m=+88714.902440864",
        "LastUpdateTime": "2024-06-14 15:31:07.143863491 +0800 CST m=+88714.902440914",
        "TlsConfig": {
            "EnableLog": true,
            "TlsProjectId": "a40202c5-fe22-4ea7-******",
            "TlsTopicId": "2ff955cb-1f03-4b9b-******"
        },
        "ResourcePoolId": "ujdsugabcd",
        "Owner": "22******",
        "TriggersCount": 0,
        "UseStatus": "normal",
        "DebugInstanceEnable": true,
        "InstanceType": "",
        "NasStorage": {
            "EnableNas": true,
            "NasConfigs": [
                {
                    "FileSystemId": "cnas-cnbjb******",
                    "MountPointId": "mount-bce15678",
                    "RemotePath": "/",
                    "LocalMountPath": "/mnt/nas",
                    "Uid": 1000,
                    "Gid": 1000
                }
            ]
        },
        "TosMountConfig": {
            "EnableTos": true,
            "MountPoints": [
                {
                    "Endpoint": "http://tos-cn-beijing.ivolces.com",
                    "BucketName": "ai-models",
                    "BucketPath": "/",
                    "LocalMountPath": "/mnt/tos",
                    "ReadOnly": false
                }
            ]
        },
        "InitializerSec": 30
    }
}

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。