ListFunctions - Function Compute - Alibaba Cloud Documentation Center

Queries functions.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /2021-04-06/services/{serviceName}/functions

Request parameters

Parameter	Type	Required	Description	Example
serviceName	string	Yes	The name of the service.	demoService
qualifier	string	No	The version or alias of the service.	LATEST
limit	integer	No	The maximum number of resources to return. Default value: 20. Maximum value: 100. The number of returned resources is less than or equal to the specified number.	20
nextToken	string	No	The token required to obtain more results. If the number of resources exceeds the limit, the nextToken parameter is returned. You can include the parameter in subsequent calls to obtain more results. You do not need to provide this parameter in the first call.	8bj81uI8n****
prefix	string	No	The prefix that the names of returned resources must contain.	demoFunctionsPrefix
startKey	string	No	The starting position of the result list. The returned resources are sorted in alphabetical order, and the resources that include and follow the resource specified by the startKey parameter are returned.	demoStartKey
X-Fc-Account-Id	string	No	The ID of your Alibaba Cloud account.	188077086902****
X-Fc-Date	string	No	The time when the function is invoked. The format is EEE,d MMM yyyy HH:mm:ss GMT.	Wed, 11 May 2022 09:00:00 GMT
X-Fc-Trace-Id	string	No	The custom request ID.	rid281s******

Response parameters

Parameter	Type	Description	Example
	object	The returned data.
functions	object []	The information about functions.
codeChecksum	string	The CRC-64 value of the function code package.	5434025278388143772
codeSize	long	The size of the function code package that is returned by the system. Unit: bytes.	1024
createdTime	string	The time when the function was created.	2016-08-15T15:00:00.000+0000
customContainerConfig	CustomContainerConfig	The configurations of the custom container runtime.
description	string	The description of the function.	This is a demo hello world function
environmentVariables	object	The environment variables that you configured for the function. You can obtain the values of the environment variables from the function.
	string	The environment variables that you configured for the function.	{"key":"value"}
functionId	string	The unique ID that is generated by the system for the function.	2d28e0e9-9ba5-4eed-8b1a-d3d9cd24****
functionName	string	The name of the function.	demo-function
handler	string	The handler of the function.	index.handler
lastModifiedTime	string	The time when the function was last modified.	2016-08-15T17:00:00.000+0000
memorySize	integer	The memory size that is configured for the function. Unit: MB.	512
runtime	string	The runtime environment of the function. Valid values: nodejs16, nodejs14, nodejs12, nodejs10, nodejs8, nodejs6, nodejs4.4, python3.10, python3.9, python3, python2.7, java11, java8, go1, php7.2, dotnetcore3.1, dotnetcore2.1, custom.debian10, custom, and custom-container. For more information, see Supported function runtime environments.	python3.9
timeout	integer	The timeout period for the execution of the function. Unit: seconds. Default value: 60. Valid values: 1 to 600. When this period expires, the execution of the function is terminated.	10
initializationTimeout	integer	The timeout period for the execution of the Initializer hook. Unit: seconds. Default value: 3. Valid values: 1 to 300. When this period ends, the execution of the Initializer hook is terminated.	60
initializer	string	The handler of the Initializer hook. The format of the value is determined by the programming language that you use. For more information, see Initializer hook.	index.handler
caPort	integer	The port on which the HTTP server listens for the custom runtime or custom container runtime.	9000
instanceConcurrency	integer	The number of requests that can be concurrently processed by a single instance.	10
instanceSoftConcurrency	integer	The soft concurrency of the instance. You can use this parameter to implement graceful scale-up of instances. If the number of concurrent requests on an instance is greater than the value of soft concurrency, an instance scale-up is triggered. For example, if your instance requires a long time to start, you can specify a suitable soft concurrency to start the instance in advance. The value must be less than or equal to that of the instanceConcurrency parameter.	5
instanceType	string	The instance type of the function. Valid values: e1: elastic instance c1: performance instance fc.gpu.tesla.1: GPU-accelerated instance (Tesla T4) fc.gpu.ampere.1: GPU-accelerated instance (Ampere A10) g1: same as fc.gpu.tesla.1	e1
layers	array	The information about layers. NoteMultiple layers are merged based on the order of array subscripts. The content of a layer with a smaller subscript overwrites the file that has the same name as a layer with a larger subscript.
	string	The name of the layer.	02f81d283888f5ec63442a88fe82b260#Layer-name#1
instanceLifecycleConfig	InstanceLifecycleConfig	The lifecycle configurations of the instance.
customHealthCheckConfig	CustomHealthCheckConfig	The custom health check configuration of the function. This parameter is applicable only to custom runtimes and custom containers.
cpu	float	The number of vCPUs of the function. The value must be a multiple of 0.05.	1.5
diskSize	integer	The disk size of the function. Unit: MB. Valid values: 512 and 10240.	512
gpuMemorySize	integer	The GPU memory capacity for the function. Unit: MB. The value is a multiple of 1,024.	2048
nextToken	string	The token used to obtain more results. If this parameter is not returned, all the layers are returned.	8bj81uI8n****

Examples

Sample success responses

JSONformat

{
  "functions": [
    {
      "codeChecksum": "5434025278388143772",
      "codeSize": 1024,
      "createdTime": "2016-08-15T15:00:00.000+0000",
      "customContainerConfig": {
        "args": "[\"-arg1\", \"value1\"]",
        "command": "[\"/code/myserver\"]",
        "image": "registry-vpc.cn-hangzhou.aliyuncs.com/fc-demo/helloworld:v1beta1",
        "accelerationType": "Default",
        "instanceID": "cri-xxxxxxxxxx",
        "webServerMode": true
      },
      "description": "This is a demo hello world function",
      "environmentVariables": {
        "key": "{\"key\":\"value\"}"
      },
      "functionId": "2d28e0e9-9ba5-4eed-8b1a-d3d9cd24****",
      "functionName": "demo-function",
      "handler": "index.handler",
      "lastModifiedTime": "2016-08-15T17:00:00.000+0000",
      "memorySize": 512,
      "runtime": "python3.9",
      "timeout": 10,
      "initializationTimeout": 60,
      "initializer": "index.handler",
      "caPort": 9000,
      "instanceConcurrency": 10,
      "instanceSoftConcurrency": 5,
      "instanceType": "e1",
      "layers": [
        "02f81d283888f5ec63442a88fe82b260#Layer-name#1"
      ],
      "instanceLifecycleConfig": {
        "preFreeze": {
          "handler": "index.preStop",
          "timeout": 10
        },
        "preStop": {
          "handler": "index.preStop",
          "timeout": 10
        }
      },
      "customHealthCheckConfig": {
        "httpGetUrl": "/ready",
        "initialDelaySeconds": 1,
        "periodSeconds": 1,
        "timeoutSeconds": 2,
        "failureThreshold": 1,
        "successThreshold": 2
      },
      "cpu": 1.5,
      "diskSize": 512,
      "gpuMemorySize": 2048
    }
  ],
  "nextToken": "8bj81uI8n****"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2022-11-28

The internal configurations of the API operation change but you can still call the operation.

Change item	Change content
	The internal configurations of the API operation change but you can still call the operation.

2021-06-30

The input parameters of the API operation change.

Change item	Change content
Input Parameters	The input parameters of the API operation change.
	Added Input Parameters: X-Fc-Account-Id
	Added Input Parameters: X-Fc-Code-Checksum
	Added Input Parameters: X-Fc-Log-Type
	Added Input Parameters: X-Fc-Invocation-Type
	Added Input Parameters: X-Fc-Date
	Added Input Parameters: X-Fc-Trace-Id

2021-06-30

The input parameters of the API operation change.

Change item	Change content
Input Parameters	The input parameters of the API operation change.
	Added Input Parameters: X-Fc-Account-Id

2021-06-30

The input parameters of the API operation change.

Change item	Change content
Input Parameters	The input parameters of the API operation change.
	delete Input Parameters: X-Fc-Account-Id