Create a function, including function configurations and function code.

Request description

Request method: POST

Request address: http://open.volcengineapi.com/?Action=CreateFunction&Version=2024-06-06

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Parameter	Type	Require	Sample value	Description
Action	String	Yes	CreateFunction	Interface name. The current API is called CreateFunction.
Version	String	Yes	2024-06-06	Interface version. The current version of the API is 2024-06-06 .
Name	String	Yes	official-site	Function name. The function name must be only in the same account. It supports uppercase and lowercase English letters, numbers, dashes (-), and underscores (_), the length limit is 4 to 64 characters.
Description	String	No	Lightweight official website	Function description. The length limit is 1,000 Unicode characters or less.
Runtime	String	Yes	python3.8/v1	Function Runtime. Available values: golang/v1 native/v1 nativejava8/v1 node14/v1 node20/v1 nodeprime14/v1 python3.12/v1 python3.8/v1 python3.9/v1 tip When SourceType = image, the runtime must be native/v1.
ExclusiveMode	Boolean	No	false	Exclusive mode switch. Available values: true: Turn off multiple concurrent requests per instance, that is, the exclusive mode in which a single instance can only process one request at a time. false: (default) Turn on multiple concurrent requests per instance, that is, the non-exclusive mode in which a single instance can handle multiple requests at the same time, and you can set the maximum number of concurrent requests that a single instance can carry through MaxConcurrency.
RequestTimeout	Integer	No	30	Request timed out. Unit: second. Value range: 1 to 900. Default value: 30.
MaxConcurrency	Integer	No	100	Single instance maximum concurrency. It takes effect when ExclusiveMode = false. Value range: 10~1,000. Default value: 100.
MemoryMB	Integer	No	1,024	Maximum memory per instance. Unit: MiB. Value range: 512~4,096. Description The value takes 512 as the gradient. Default value: 1,024.
SourceType	String	No	tos	Code source type, optional values are: tos: Torch Object Storage. zip: Local compressed file. image: Container Registry.
Source	String	No	pqyqo9qa/3kwem******.zip	Code source, value: zip: Base64 encoded binary ZIP file. tos: String in the format bucket_name: object_key, e.g.: vefaas-test: vefaas-python38-default.zip. image: The image address in the format host/namespace/repo: tag. E.g.: cp-enterprise-cn-beijing.cr.volces.com/demo/nginx: latest.
Envs	Array of EnvVar	No	-	Environment variables.
VpcConfig	Object of VpcConfig	No	-	Virtual Private Cloud (VPC) configuration.
TlsConfig	Object of TlsConfig	No	-	Torch Log Service (TLS) relevant configuration.
SourceAccessConfig	Object of SourceAccessConfig	No	-	Container Registry access configuration. warning You need to provide access configuration when setting custom images across accounts.
Tags	Array of Tag	No	-	Function label.
NasStorage	Object of NasStorage	No	-	FileNAS mount configuration.
TosMountConfig	Object of TosMountConfig	No	-	Torch Object Storage (TOS) mount configuration.
InitializerSec	Integer	No	30	Function initialization timeout configuration.
Command	String	No	./run.sh	Custom start command for the instance (currently only supports native/v1 runtimes).
Port	Integer	No	8,000	Custom listening port for the instance (currently only native/v1 runtime is supported).
CpuStrategy	String	No	always	Function CPU billing policy, when creating a function of microservices applications type, this field must be set to always to indicate that at least one instance is running.
ProjectName	String	No	default	Function associated project name.
CpuMilli	Integer	No	10	Maximum CPU per instance, unit: milli CPU. 1 milli CPU = 0.001 CPU。 When the function's compute mode is CPU instance, you can configure the CPU specification for a single CPU instance.
Cell	String	No	2	Specify the CELL cluster to which the function is assigned.
Role	String	No	trn:iam::140******:role/VeFaaSDefaultRole	Function instances bind IAM role.
EnableApmplus	Boolean	No	true	Enable application monitoring.
AsyncTaskConfig	Object of AsyncTaskConfig	No	{"EnableAsyncTask":true,"MaxRetry":3,"DestinationConfig":{"OnFailure":{"Destination":"http://dummyinstanceid.apigateway-cn-beijing-**..com/failure"},"OnSuccess":{"Destination":"http://dummyinstanceid.apigateway-cn-beijing-*.***.com/success"}}}	Asynchronous task configuration.

EnvVar

Parameter	Type	Require	Sample value	Description
Key	String	Yes	business_type	The key of an environment variable for sandbox instances.
Value	String	Yes	free	The value of the environment variable for sandbox instances.

VpcConfig

Parameter	Type	Require	Sample value	Description
EnableVpc	Boolean	Yes	false	Whether the function turns on VPC access. Parameter values: false: Disabled. The function can access the public network via the default network interface. true: Enabled. The function can access resources in the specified VPC.
VpcId	String	No	vpc-2d73mgm****	ID of the Virtual Private Cloud to which the function belongs.
SubnetIds	Array of String	No	["subnet-mj1l******"]	Subnet ID after the function enables VPC access.
SecurityGroupIds	Array of String	No	["sg-3re8ffwjclybk5zsk****"]	Security group ID corresponding to the function after VPC access is enabled.
EnableSharedInternetAccess	Boolean	No	false	The switch for the function to access the public network. Whether to access the public network through veFaaS's VPC shared NAT gateway. Parameter values: true: Turned on, access the public network through the default network interface card. Traffic charges will be incurred on the public network. false: Turned off, the function cannot access the public network through the default network interface card.

TlsConfig

Parameter	Type	Require	Sample value	Description
EnableLog	Boolean	Yes	false	Whether to enable the log feature, parameter values: true: Turned on, the stdout/stderr logs of the function will be collected into the specified logs project and logs topic of the Torch Log Service. false: Turned off, the logs are not collected.
TlsTopicId	String	No	0cd4e4c4-5436-4b05-b39e-****	TLS Logs theme ID.
TlsProjectId	String	No	48f49d74-cd50-4591-a3d0-****	TLS Logs project ID.

SourceAccessConfig

Parameter	Type	Require	Sample value	Description
Password	String	Yes	password	Container Registry password.
Username	String	Yes	operator	Container Registry user name.

Tag

Parameter	Type	Require	Sample value	Description
Key	String	Yes	business	Label key.
Value	String	Yes	ecommerce	Label value.

NasStorage

Parameter	Type	Require	Sample value	Description
EnableNas	Boolean	Yes	false	Whether to turn on NAS storage mount, parameter values: true: Turned on, store data to NAS. false: Do not turn on.
NasConfigs	Array of NasConfig	No	-	NAS storage configuration.

TosMountConfig

Parameter	Type	Require	Sample value	Description
EnableTos	Boolean	Yes	false	Whether to enable TOS storage mount. Parameter values: true: Turn on. Store data in TOS. false: Do not turn on.
Credentials	Object of Credentials	No	-	After TOS storage mount is enabled, you need to provide an access key (AK/SK) with permission to access the TOS domain name.
MountPoints	Array of TosMountPoint	No	-	After enabling Torch Object Storage mount, you need to provide a Torch Object Storage configuration list. No more than 5 items.

AsyncTaskConfig

Parameter	Type	Require	Sample value	Description
MaxRetry	Integer	No	3	Number of asynchronous task failure retries. Selectable values are 0~3.
EnableAsyncTask	Boolean	Yes	true	Whether to enable asynchronous tasks.
DestinationConfig	Object of DestinationConfig	No	-	Asynchronous task callback destination configuration.

NasConfig

Parameter	Type	Require	Sample value	Description
Gid	Long	No	1,000	User groups in the file system do not currently support customization. If this parameter is provided, its value must be consistent with the function's run user GID, and the value must be: 1000.
Uid	Long	No	1,000	User in the file system; custom users are not supported at this time. If this parameter is provided, its value must match the function's run user UID and be set to 1000.
RemotePath	String	Yes	/	File system remote directory. Length: 1~128 characters. Must start with "/", supports uppercase and lowercase letters, numbers, and special characters (- . _ ~ / : @ = + ? #).
FileSystemId	String	Yes	enas-cns******	NAS file system ID.
MountPointId	String	Yes	mount-63******	NAS mount point ID.
LocalMountPath	String	Yes	/mnt/nas	Function local mount directory. Length: 1–128 characters, must start with "/", supports uppercase and lowercase letters, digits, and special characters (- . _ ~ / : @ = + ? #).

Credentials

Parameter	Type	Require	Sample value	Description
AccessKeyId	String	Yes	******	AccessKey ID (AK) of the Volcano Engine root user. For the obtaining method, please refer to the Access key usage guide .
SecretAccessKey	String	Yes	******	Secret Access Key (SK) for the Volcano Engine root user. For the obtaining method, please refer to the Access key usage guide .

TosMountPoint

Parameter	Type	Require	Sample value	Description
Endpoint	String	Yes	http://tos-cn-beijing.ivolces.com	TOS accesses the domain name.
ReadOnly	Boolean	No	true	Function local directory access permission. After mounting the TOS Bucket, whether the function's local mount directory is read-only. Parameter values: true: Read only false(default): Read and write
BucketName	String	Yes	ai-model	TOS bucket name
BucketPath	String	Yes	/	The mount TOS Bucket path.
LocalMountPath	String	Yes	/mnt/tos	Function local mount directory.

DestinationConfig

Parameter	Type	Require	Sample value	Description
OnFailure	Object of Destination	No	-	Callback target configuration when task execution fails.
OnSuccess	Object of Destination	No	-	Callback target configuration when the task is executed successfully.

Destination

Parameter	Type	Require	Sample value	Description
Destination	String	No	http://dummyinstanceid.apigateway-cn-beijing-****.volceapi.com	Specific callback destination. Setting the value to an empty string ("") disables the callback.

Sample requests

Response parameters

Parameter	Type	Sample value	Description
Id	String	pqy******	Function ID.
Name	String	official-site	Function name.
Description	String	Lightweight official website	Function description.
Runtime	String	python3.8/v1	Function Runtime.
ExclusiveMode	Boolean	false	Exclusive mode switch. true: Turn off multiple concurrent requests per instance, that is, the exclusive mode in which a single instance can only process one request at a time. false (default): Turn on multiple concurrent requests per instance, that is, the non-exclusive mode where a single instance can handle multiple requests at the same time, and you can set the maximum number of concurrent requests that a single instance can carry through MaxConcurrency.
RequestTimeout	Integer	30	Request timed out (the unit is second).
MaxConcurrency	Integer	100	Single instance maximum concurrency.
MemoryMB	Integer	1,024	Maximum memory per instance (the unit is MB).
CodeSize	Integer	473	Code package size (the unit is MB).
CodeSizeLimit	Integer	256	The code package size limit. SourceType=zip，CodeSizeLimit=15MB. SourceType=tos，CodeSizeLimit=256MB.
Source	String	pqy****/3kwem****.zip	User-entered code/image address.
SourceLocation	String	https://vefaas.tos-s3-cn.volces.com/template_dir/666ad75b9124c400072abcvefaas-python3.9-default.zip?X-Amz******	The source address of the code/image.
SourceType	String	tos	Code source type, optional values are: tos: Torch Object Storage. zip: Local compressed file. image: Container Registry.
Envs	Array of EnvVar	-	Function Environment variables.
VpcConfig	Object of VpcConfig	-	VPC configuration.
CreationTime	String	2024-06-14 15:31:07.143863441 +0800 CST m=+88714.902440864	Creation time.
LastUpdateTime	String	2024-06-14 15:31:07.143863491 +0800 CST m=+88714.902440914	Update time.
TlsConfig	Object of TlsConfig	-	Function logs configuration.
Owner	String	22******	Function owner (account Id).
TriggersCount	Integer	0	The number of triggers for this function.
InstanceType	String	nvidia-tesla-l4	Function instance type: Empty value: CPU instance type. Non-empty value: Specific type of GPU instance.
NasStorage	Object of NasStorage	-	FileNAS mount configuration.
TosMountConfig	Object of TosMountConfig	-	Torch Object Storage TOS mount configuration.
InitializerSec	Integer	30	Function initialization timeout configuration.
Command	String	./run.sh	Custom start command for the instance (currently only supports native/v1 runtimes).
Port	Integer	8,000	Custom listening port for the instance (currently only native/v1 runtime is supported).
CpuStrategy	String	always	Function CPU billing policy, when the function is of microservices applications type, this field is always, indicating that at least one instance is running.
ProjectName	String	default	Function associated project name.
FunctionType	String	sandbox	Function type.
Cell	String	2	Cell to which the function belongs.
Role	String	trn:iam::1400000044:role/VeFaaSDefaultRole	IAM role bound to function instances.
EnableApmplus	Boolean		Turn on application monitoring.
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"}}}	Asynchronous task configuration.