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

请求说明

请求方式：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：对象存储。 zip：本地压缩文件。 image：镜像仓库。
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	否	-	镜像仓库的访问配置。注意设置跨账号的自定义镜像时，需要提供访问配置。
Tags	Array of Tag	否	-	函数标签。
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	函数关联的项目名称。
CpuMilli	Integer	否	10	单实例最大 CPU，单位为 milli CPU。1 milli CPU = 0.001 CPU。函数的计算模式为 CPU 实例时，可配置单个 CPU 实例的 CPU 规格。
Cell	String	否	2	指定函数分配到某个 CELL 集群。
Role	String	否	trn:iam::140******:role/VeFaaSDefaultRole	函数实例绑定 IAM 角色。
EnableApmplus	Boolean	否	true	开启应用监控。
AsyncTaskConfig	Object of AsyncTaskConfig	否	{"EnableAsyncTask":true,"MaxRetry":3,"DestinationConfig":{"OnFailure":{"Destination":"http://dummyinstanceid.apigateway-cn-beijing-**..com/failure"},"OnSuccess":{"Destination":"http://dummyinstanceid.apigateway-cn-beijing-*.***.com/success"}}}	异步任务配置。

EnvVar

参数	类型	是否必选	示例值	描述
Key	String	是	business_type	沙箱实例环境变量的键。
Value	String	是	free	沙箱实例环境变量的值。

VpcConfig

参数	类型	是否必选	示例值	描述
EnableVpc	Boolean	是	false	函数是否开启 VPC 访问。参数值： false：不启用，函数可通过默认网卡访问公网。 true：启用，函数可访问指定 VPC 中的资源。
VpcId	String	否	vpc-2d73mgm****	函数所属 VPC 的 ID。
SubnetIds	Array of String	否	["subnet-mj1l******"]	函数开启 VPC 访问后，对应的子网 ID。
SecurityGroupIds	Array of String	否	["sg-3re8ffwjclybk5zsk****"]	函数开启 VPC 访问后，对应的安全组 ID。
EnableSharedInternetAccess	Boolean	否	false	函数访问公网开关。是否通过函数服务的 VPC 共享 NAT 网关，访问公网。参数值： true：开启，通过默认网卡访问公网。会产生公网出流量费用。 false：关闭，函数无法通过默认网卡访问公网。

TlsConfig

参数	类型	是否必选	示例值	描述
EnableLog	Boolean	是	false	是否启用日志功能，参数值： true：开启，函数的 stdout/stderr 日志将被采集至日志服务的指定日志项目和日志主题中。 false：关闭，不采集日志。
TlsTopicId	String	否	0cd4e4c4-5436-4b05-b39e-****	TLS 日志主题 ID。
TlsProjectId	String	否	48f49d74-cd50-4591-a3d0-****	TLS 日志项目 ID。

SourceAccessConfig

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

Tag

参数	类型	是否必选	示例值	描述
Key	String	是	business	标签键。
Value	String	是	ecommerce	标签值。

NasStorage

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

TosMountConfig

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

AsyncTaskConfig

参数	类型	是否必选	示例值	描述
MaxRetry	Integer	否	3	异步任务失败重试次数，可选择值为 0~3。
EnableAsyncTask	Boolean	是	true	是否开启异步任务。
DestinationConfig	Object of DestinationConfig	否	-	异步任务回调目标配置。

NasConfig

参数	类型	是否必选	示例值	描述
Gid	Long	否	1000	文件系统中的用户组，暂时不支持自定义。如果提供该参数，参数值必须和函数 run user gid 保持一致，取值为：1000。
Uid	Long	否	1000	文件系统中的用户，暂时不支持自定义。如果提供该参数，参数值必须和函数 run user uid 保持一致，取值为：1000。
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	函数本地挂载目录。

DestinationConfig

参数	类型	是否必选	示例值	描述
OnFailure	Object of Destination	否	-	任务执行失败时，回调目标配置。
OnSuccess	Object of Destination	否	-	任务执行成功时，回调目标配置。

Destination

参数	类型	是否必选	示例值	描述
Destination	String	否	http://dummyinstanceid.apigateway-cn-beijing-****.volceapi.com	具体回调目标，取值设置为空（""）表示禁用该回调。

请求示例

返回参数

参数	类型	示例值	描述
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。
Source	String	pqy****/3kwem****.zip	用户输入的代码/镜像地址。
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	函数关联的项目名称。
FunctionType	String	sandbox	函数类型。
Cell	String	2	函数所属 Cell。
Role	String	trn:iam::1400000044:role/VeFaaSDefaultRole	函数实例绑定的 IAM 角色。
EnableApmplus	Boolean		开启应用监控。
AsyncTaskConfig	Object of AsyncTaskConfig	{"EnableAsyncTask":true,"MaxRetry":3,"DestinationConfig":{"OnFailure":{"Destination":"http://dummyinstanceid.apigateway-cn-beijing-inner.volceapi.com/failure"},"OnSuccess":{"Destination":"http://dummyinstanceid.apigateway-cn-beijing-inner.volceapi.com/success"}}}	异步任务配置。