Obtain function details, including function configurations and code.

Request description

Request method: POST

Request address: http://open.volcengineapi.com/?Action=GetFunction&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	GetFunction	Interface name. The current API is called GetFunction.
Version	String	Yes	2024-06-06	Interface version. The current version of the API is 2024-06-06 .
Id	String	Yes	pqyqo9qa	Function ID.

Sample requests

Response parameters

Parameter	Type	Sample value	Description
Id	String	pqyqo9qa	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.
CodeSize	Integer	473	Code package size.
CodeSizeLimit	Integer	256	The code package size limit. 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******	The source address of the code/image.
SourceType	String	tos	Code source type: 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******	Account ID of the function owner.
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 GPU instance type.
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, only supported by native/v1 runtime.
Port	Integer	8,000	Custom listening port for the instance, supported only by native/v1 runtime.
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	Project name.
FunctionType	String	sandbox	Function type.
Cell	String	2	Cell to which the function belongs.
Role	String	trn:iam::1400000044:role/VeFaaSDefaultRole	Bind IAM role to function instances.
EnableApmplus	Boolean	ture	Turn on application monitoring.
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"}}}	Asynchronous task configuration.

EnvVar

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

VpcConfig

Parameter	Type	Sample value	Description
EnableVpc	Boolean	false	Whether the function enables VPC access. Parameter value: false: Not enabled; 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	vpc-2d73mgm****	ID of the VPC to which the function belongs.
SubnetIds	Array of String	["subnet-mj1l******"]	Subnet ID after the function turns on VPC access.
SecurityGroupIds	Array of String	["sg-3re8ffwjclybk5zsk****"]	Security group ID after the function turns on VPC access.
EnableSharedInternetAccess	Boolean	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 value: 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	Sample value	Description
EnableLog	Boolean	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	0cd4e4c4-5436-4b05-b39e-****	TLS Logs theme ID.
TlsProjectId	String	48f49d74-cd50-4591-a3d0-****	TLS Logs project ID.

NasStorage

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

TosMountConfig

Parameter	Type	Sample value	Description
EnableTos	Boolean	false	Whether to enable TOS storage mount, parameter value: true: Enabled; data will be stored in TOS. false: Do not turn on.
Credentials	Object of Credentials	-	After turning on TOS storage mount, you need to provide an access key (AK/SK) with TOS domain name access permission.
MountPoints	Array of TosMountPoint	-	After turning on TOS storage mount, you need to provide a TOS storage configuration list. No more than 5.

AsyncTaskConfig

Parameter	Type	Sample value	Description
MaxRetry	Integer	3	Number of asynchronous task retry attempts after failure, selectable values are 0~3.
EnableAsyncTask	Boolean	true	Whether to enable asynchronous tasks.
DestinationConfig	Object of DestinationConfig	-	Asynchronous task callback target configuration.

NasConfig

Parameter	Type	Sample value	Description
Gid	Long	1,000	User group in the file system. Custom settings are currently not supported. If this parameter is provided, the parameter value must be consistent with the function's run user GID, and the value must be: 1000.
Uid	Long	1,000	User in the file system; custom user configuration is not supported for now. If this parameter is provided, its value must match the UID of the function's run user and must be: 1000.
RemotePath	String	/	File system remote directory. Length 1~128 characters, must start with "/", supports uppercase and lowercase letters, numbers, and special characters (- . _ ~ / : @ = + ? #).
FileSystemId	String	enas-cns******	NAS file system ID.
MountPointId	String	mount-63******	NAS mount point ID.
LocalMountPath	String	/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	Sample value	Description
AccessKeyId	String	******	AccessKey ID (AK) of the Volcano Engine root user. For the obtaining method, please refer to the Access key usage guide .
SecretAccessKey	String	******	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	Sample value	Description
Endpoint	String	http://tos-cn-beijing.ivolces.com	TOS accesses the domain name.
ReadOnly	Boolean	true	Function local directory access permission. After mounting the TOS Bucket, specifies whether the function's local mount directory is read-only. Parameter values: true: Read only false(default): Read and write
BucketName	String	ai-model	TOS bucket name
BucketPath	String	/	The mount TOS Bucket path.
LocalMountPath	String	/mnt/tos	Function local mount directory.

DestinationConfig

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

Destination

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

Sample responses

Error codes

There is no error code dedicated to this interface currently. If you encounter an exception when calling the interface, you can refer to Public error codes for troubleshooting.

Volcano Engine Function as a Service