Creates a function.
Request headers
This operation uses common request headers and special request headers. The following table describes the special request header. For information about common request headers, see Common parameters.
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
X-Fc-Code-Checksum | String | No | 543402527838814**** |
The CRC-64 value of the function code package. |
Request syntax
POST /services/{serviceName}/functions HTTP/1.1
Request parameters
Parameter | Type | Position | Required | Example | Description |
---|---|---|---|---|---|
serviceName | String | Path | Yes | service_name |
The name of the service. |
Object | Body | No |
The definition of the function. |
||
code | Code | Body | No |
The code package in ZIP format. |
|
customContainerConfig | CustomContainerConfig | Body | No |
The configurations of the custom container runtime. After you configure the custom container runtime, you can use a custom container image to execute functions. |
|
layers | Array of String | Body | No | 02f81d283888f5ec63442a88fe82b260#Layer-name#1 |
The name of the layer. |
description | String | Body | No | test_description |
The description of the function. |
functionName | String | Body | Yes | function_name |
The name of the function. |
handler | String | Body | Yes | index.handler |
The handler of the function. The format is determined by the programming language that you use. For more information, see Function handlers. |
initializationTimeout | Integer | Body | No | 30 |
The timeout period for the execution of the initializer function. Unit: seconds. Default value: 3. Valid values: 1 to 300. When this period ends, the execution of the initializer function is terminated. |
initializer | String | Body | No | index.initializer |
The handler of the initializer function. The format of the value is determined by the programming language that you use. For more information, see Initializer function. |
memorySize | Integer | Body | No | 256 |
The memory size for the function. Unit: MB. The memory size is a multiple of 64 MB. The memory sizes of instances vary based on the type of the function instance. For more information, see Instance specifications. |
runtime | String | Body | No | python3 |
The runtime environment of the function. The following runtime environments are supported: Node.js 6.x, Node.js 8.x, Node.js 10.x, Node.js 12.x, Node.js 14.x, Python 2.7, Python 3, Java 8, Java 11, PHP 7.2, .NET Core 2.1, Go 1.x, custom runtimes and custom container runtimes. For more information about the runtime environments that are supported by Function Compute, see Supported function runtime environments. |
timeout | Integer | Body | No | 60 |
The timeout period for the execution of the function. Unit: seconds. Default value: 60. Valid values: 1 to 86400. When this period ends, the execution of the function is terminated. |
caPort | Integer | Body | No | 9000 |
The port on which the HTTP server listens for the custom runtime or custom container runtime. |
Function code packages can be provided in the following two methods. You must use only one of the methods in a single request.
- Specify the name of the Object Storage Service (OSS) bucket (ossBucketName) in which the code package is stored and the name of the object (ossObjectName).
- Set the value of the zipFile parameter to the Base64-encoded content of the ZIP file.
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
ETag | String | 738136ea26b79cee660862cd7628**** |
The value used to ensure that the modified function is consistent with the function to be modified. |
codeChecksum | String | 2825179536350**** |
The CRC-64 value of the function code package. |
codeSize | Long | 421 |
The size of the function code package. Unit: byte. |
createdTime | String | 2020-04-01T08:15:27Z |
The time when the function was created. |
customContainerConfig | CustomContainerConfig |
The configurations of the custom container runtime. After you configure the custom container runtime, you can use a custom container image to execute functions. |
|
layers | Array of String | 02f81d283888f5ec63442a88fe82b260#Layer-name#1 |
The name of the layer. |
description | String | test_description |
The description of the function. |
environmentVariables | Map |
The environment variables that you configured for the function. You can obtain the values of the environment variables from the function. For more information, see Overview. |
|
functionId | String | fc46822c-0fb9-4c15-b898-bace828a**** |
The ID that is generated by the system for each function. The ID must be globally unique. |
functionName | String | function_name |
The name of the function. |
handler | String | index.handler |
The handler of the function. The format is determined by the programming language that you use. For more information, see Function handlers. |
lastModifiedTime | Long | 2020-04-01T08:15:27Z |
The time when the function was last updated. |
memorySize | Integer | 256 |
The memory size for the function. Unit: MB. The memory size is a multiple of 64 MB. The memory sizes for instances vary based on the types of the function instances. For more information, see Instance specifications. |
runtime | String | python3 |
The runtime environment of the function. The following runtime environments are supported: Node.js 6.x, Node.js 8.x, Node.js 10.x, Node.js 12.x, Node.js 14.x, Python 2.7, Python 3, Java 8, Java 11, PHP 7.2, .NET Core 2.1, Go 1.x, custom runtimes and custom container runtimes. For more information about the runtime environments that are supported by Function Compute, see Supported function runtime environments. |
timeout | Integer | 60 |
The timeout period for the execution of the function. Unit: seconds. Default value: 60. Valid values: 1 to 86400. When this period ends, the execution of the function is terminated. |
initializationTimeout | Integer | 60 |
The timeout period for the execution of the initializer function. Unit: seconds. Default value: 3. Valid values: 1 to 300. When this period ends, the execution of the initializer function is terminated. |
initializer | String | index.handler |
The handler of the initializer function. The format of the value is determined by the programming language that you use. For more information, see Initializer function. |
caPort | Integer | 9000 |
The port on which the HTTP server listens for the custom runtime or custom container runtime. |
Examples
Sample requests
POST /services/service_name/functions HTTP/1.1
Host:fc-ram.aliyuncs.com
X-Fc-Code-Checksum:543402527838814****
Content-Type:application/json
{
"code" : {
"ossBucketName" : "demo-bucket",
"ossObjectName" : "demo-key",
"zipFile" : "cHJpbnQoImhlbGxvIHdvcmxkIikK"
},
"customContainerConfig" : {
"args" : "[\"-arg1\", \"value1\"]",
"command" : "[\"/code/myserver\"]",
"image" : "registry-vpc.cn-hangzhou.aliyuncs.com/fc-demo/helloworld:v1beta1",
"accelerationType" : "Default",
"instanceID" : "cri-xxxxxxxx"
},
"layers" : [ "02f81d283888f5ec63442a88fe82b260#Layer-name#1" ],
"description" : "test_description",
"functionName" : "function_name",
"handler" : "index.handler",
"initializationTimeout" : 30,
"initializer" : "index.initializer",
"memorySize" : 256,
"runtime" : "python3",
"timeout" : 60,
"caPort" : 9000
}
Sample success responses
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"codeChecksum" : "2825179536350****",
"codeSize" : 421,
"createdTime" : "2020-04-01T08:15:27Z",
"customContainerConfig" : {
"args" : "[\"-arg1\", \"value1\"]",
"command" : "[\"/code/myserver\"]",
"image" : "registry-vpc.cn-hangzhou.aliyuncs.com/fc-demo/helloworld:v1beta1",
"accelerationType" : "Default",
"instanceID" : "cri-xxxxxxxx"
},
"layers" : [ "02f81d283888f5ec63442a88fe82b260#Layer-name#1" ],
"description" : "test_description",
"functionId" : "aa715851-1c20-4b89-a8fb-***",
"functionName" : "function_name",
"handler" : "index.handler",
"memorySize" : 256,
"runtime" : "python3",
"timeout" : 60,
"initializationTimeout" : 60,
"initializer" : "index.handler",
"caPort" : 9000
}