Obtain the version configurations of functions in batch.

Request description

Request method: POST

Request address: http://open.volcengineapi.com/?Action=ListRevisions&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	ListRevisions	Interface name. The current API is called ListRevisions.
Version	String	Yes	2024-06-06	Interface version. The current version of the API is 2024-06-06 .
FunctionId	String	Yes	pqy******	Function ID.
PageNumber	Integer	No	1	Paging parameter, the current page number is default 1.
PageSize	Integer	No	10	Paging parameter, the size per page is default 10.
Filters	Array of Filter	No	-	Query filter criteria.

Filter

Parameter	Type	Require	Sample value	Description
Name	String	No	RevisionNumber	The filter key name of the query, only RevisionNumber (version number) is supported. tip Filtered values do not support fuzzy queries.
Values	Array of String	No	["2"]	Filter value for the query (Value). Multiple values are separated by half-width commas (,).

Sample requests

Response parameters

Parameter	Type	Sample value	Description
Items	Array of FunctionRevision	-	Function revision details list.
Total	Integer	1	The total amount of the data in the response list.

FunctionRevision

Parameter	Type	Sample value	Description
Id	String	nw******	Function ID.
Envs	Array of EnvVar	-	Function Environment variables.
Name	String	official-site	Function name.
Source	String	templates/vefaas-python38-default.zip	Code/image source.
Runtime	String	python3.8/v1	Function Runtime.
CodeSize	Integer	1,024	Code package size.
MemoryMB	Integer	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.
TlsConfig	Object of TlsConfig	-	Function TLS Logs configuration.
VpcConfig	Object of VpcConfig	-	VPC configuration.
NasStorage	Object of NasStorage	-	FileNAS configuration.
SourceType	String	tos	Code Source type.
Description	String	This is a description	Function description.
MaxReplicas	Integer	10	Maximum number of instances.
CreationTime	String	2020-05-20T13:00:55Z	Function creation time.
InstanceType	String	nvidia-tesla-l4	Function instance type. Null value: CPU instance. Non-null value: GPU instance.
CodeSizeLimit	Integer	64	The code package size limit. Only the Volcano Engine root user can be configured. Default value: 64 MiB. Native function default value: 256 MiB.
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.
InitializerSec	Integer	30	Function initialization timeout configuration.
MaxConcurrency	Integer	100	Single instance maximum concurrency. It takes effect when ExclusiveMode=false, and the value range: 10~1,000.
RequestTimeout	Integer	30	Request timed out. Unit: second. Value range: 1 to 900. Default value: 30.
RevisionNumber	Integer	1	Function version number.
SourceLocation	String	tos://tos-cn-beijing.volces.com/test.zip	The source address of the code/image.
TosMountConfig	Object of TosMountConfig	-	TOS Torch Object Storage mount configuration.
RevisionDescription	String	This is a revision description	Function version description.
RevisionCreationTime	String	2020-05-20T13:00:55Z	Version creation time.
Role	String	trn:iam::1400000044:role/VeFaaSDefaultRole	Function instance binds IAM role
FunctionType	String	sandbox	Function type.
AsyncTaskConfig	Object of AsyncTaskConfig	{"EnableAsyncTask":true,"MaxRetry":3,"DestinationConfig":{"OnFailure":{"Destination":"http://dummyinstanceid.apigateway-cn-beijing-****.volceapi.com/failure"},"OnSuccess":{"Destination":"http://dummyinstanceid.apigateway-cn-beijing-inner.volceapi.com/success"}}}	Asynchronous task configuration.
HealthCheckConfig	Object of HealthCheckConfig	-	Health check 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.

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.

VpcConfig

Parameter	Type	Sample value	Description
EnableVpc	Boolean	false	Whether to enable VPC access for the function. Parameter values: 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 corresponding to the function after VPC access is enabled.
SecurityGroupIds	Array of String	["sg-3re8ffwjclybk5zsk****"]	Security group ID corresponding to the function after VPC access is enabled.
EnableSharedInternetAccess	Boolean	false	The switch for the function to access the public network. Whether to access the public network via 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.

NasStorage

Parameter	Type	Sample value	Description
EnableNas	Boolean	false	Whether to enable NAS storage mount, parameter values: 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 values: true: Enabled; data is stored in TOS. false: Do not turn on.
Credentials	Object of Credentials	-	After enabling TOS storage mount, you need to provide access keys (AK/SK) with TOS domain access permission.
MountPoints	Array of TosMountPoint	-	After enabling TOS storage mount, you need to provide the TOS storage configuration list. A maximum of 5.

AsyncTaskConfig

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

HealthCheckConfig

Parameter	Type	Sample value	Description
EnableHealthCheck	Boolean	true	Whether to turn on health check: true: Turn on. false: Turn off.
ProbeHandler	Object of ProbeHandler	-	Type of health check.
InitialDelaySeconds	Integer	5	Delay before the first health check, in seconds.
PeriodSeconds	Integer	10	The interval between each health check, in seconds.
TimeoutSeconds	Integer	2	Timeout for each health check, in seconds.
FailureThreshold	Integer	3	The number of consecutive failures required before a probe is judged to fail.
SuccessThreshold	Integer	3	The number of consecutive successes required before a probe is judged to be successful.

NasConfig

Parameter	Type	Sample value	Description
Gid	Long	1,000	User group in the file system. Customization is not supported for now. If this parameter is provided, its value must match the function run user gid, which is: 1000.
Uid	Long	1,000	User in the file system; custom settings are not supported at this time. If this parameter is provided, the parameter value must be consistent with the function run user uid, with a value of: 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, numbers, 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, whether the function 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 for successful task execution.
OnSuccess	Object of Destination	-	Callback destination configuration for failed task execution.

ProbeHandler

Parameter	Type	Sample value	Description
HTTPGet	Object of HTTPGetAction	-	Survival detection using the HTTP protocol.
TCPSocket	Object of TCPSocketAction	-	Survival detection using TCP protocol.

Destination

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

HTTPGetAction

Parameter	Type	Sample value	Description
Path	String	/hello	The path to access the HTTP server.
Port	Integer	8,080	The port number or port name to be accessed. The number must be in the range of 1 to 65535. The name must be IANA_SVC_NAME.
Scheme	String	HTTP	Protocol scheme for connecting to the host. Supported values: HTTP: Use the HTTP protocol. HTTPS: Use the HTTPS protocol. TCP: Use the TCP protocol. Default value is HTTP.
HTTPHeaders	Array of HTTPHeader	-	Custom header set in the request. HTTP allows duplicate headers.

TCPSocketAction

Parameter	Type	Sample value	Description
Port	Integer	8,080	The port number or port name to be accessed. Numbers must be in the range 1 to 65535. Name must be IANA_SVC_NAME.

HTTPHeader

Parameter	Type	Sample value	Description
Name	String	Content-Type	HTTP Header name.
Value	String	application/json	HTTP Header value.

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