获取函数详细信息，包含函数配置及函数代码。

请求说明

请求方式：POST

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

调试

API Explorer

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	GetFunction	接口名称。当前 API 的名称为 GetFunction。
Version	String	是	2024-06-06	接口版本。当前 API 的版本为 2024-06-06。
Id	String	是	pqyqo9qa	函数 ID。

请求示例

返回参数

参数	类型	示例值	描述
Id	String	pqyqo9qa	函数 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	单实例最大内存。
CodeSize	Integer	473	代码包大小。
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	项目名称。
FunctionType	String	sandbox	函数类型。
Cell	String	2	函数所属 Cell。
Role	String	trn:iam::1400000044:role/VeFaaSDefaultRole	函数实例绑定 IAM 角色。
EnableApmplus	Boolean	ture	开启应用监控。
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-inner.volceapi.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。

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	具体回调目标，取值设置为空（""）表示禁用该回调。

返回示例

错误码

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

函数服务