Help Center/ FunctionGraph/ API Reference (Kuala Lumpur Region)/ APIs/ Function Lifecycle Management/ Creating a Function

Updated on 2023-07-06 GMT+08:00

View PDF

Creating a Function

Function

This API is used to create a function.

URI

POST /v2/{project_id}/fgs/functions

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
func_name	Yes	String	Function name.
package	Yes	String	Group to which the function belongs. This field is defined to group functions.
runtime	Yes	String	Environment in which a FunctionGraph function is executed. Options: Python 2.7 Python 3.6 Python 3.9 Go 1.8 Go 1.x Java 8 Java 11 Node.js 6.10 Node.js 8.10 Node.js 10.16 Node.js 12.13 Node.js 14.18 C# (.NET Core 2.0) C# (.NET Core 2.1) C# (.NET Core 3.1) Custom PHP 7.3 HTTP Enumeration values: Java8 Java11 Node.js6.10 Node.js8.10 Node.js10.16 Node.js12.13 Node.js14.18 Python2.7 Python3.6 Go1.8 Go1.x C#(.NET Core 2.0) C#(.NET Core 2.1) C#(.NET Core 3.1) Custom PHP7.3 Python3.9 http
timeout	Yes	Integer	Maximum duration the function can be executed. Value range: 3s–900s. The value can be up to 12 hours for whitelisted users. For details, contact FunctionGraph personnel.
handler	Yes	String	Handler of a function in the format of "xx.xx". It must contain a period (.). For example, for Node.js function myfunction.handler, the file name is myfunction.js, and the handler function is handler.
depend_version_list	No	Array of strings	Dependency versions.
func_vpc	No	FuncVpc object	VPC configuration.
memory_size	Yes	Integer	Memory consumed by a function. Unit: MB. The value can be 128, 256, 512, 768, 1024, 1280, 1536, 1792, 2048, 2560, 3072, 3584 or 4096. The value ranges from 128 to 4096.
gpu_memory	No	Integer	GPU memory. This parameter is available only for functions created with a custom runtime or image. Unit: MB. Options: 1024, 2048, 3072, 4096, 5120, 6144, 7168, 8192, 9216, 10,240, 11,264, 12,288, 13,312, 14,336, 15,360, and 16,384. Range: 1024 to 16,384.
code_type	Yes	String	Function code type. Options: inline: inline code. zip: ZIP file. obs: function code stored in an OBS bucket. jar: JAR file, for Java functions. Enumeration values: inline zip obs jar
code_url	No	String	If CodeType is set to obs, enter the OBS URL of the function code package. If CodeType is not set to obs, leave this parameter blank.
code_filename	No	String	Name of a function file. This parameter is mandatory only when CodeType is set to jar or zip.
user_data	No	String	Name/Value information defined for the function. These are parameters used in the function. For example, if a function needs to access a host, define Host={host_ip}. You can define a maximum of 20 such parameters, and their total length cannot exceed 4 KB.
xrole	No	String	Agency used by the function. You need to create an agency on the IAM console. This field is mandatory when a function needs to access other services.
app_xrole	No	String	Agency used by the function app. You need to create an agency on the IAM console. This field is mandatory when a function needs to access other services.
description	No	String	Function description.
func_code	No	FuncCode object	Response body of the FuncCode struct.
initializer_handler	No	String	Initializer of the function. It is in the format of "xx.xx" and must contain a period (.). For example, for Node.js function myfunction.initializer, the file name is myfunction.js, and the initialization function is initializer.
initializer_timeout	No	Integer	Maximum duration the function can be initialized. Value range: 1s–300s.
enterprise_project_id	No	String	Enterprise project ID. This parameter is mandatory if you create a function as an enterprise user.
type	No	String	Function version. Some regions support only v1. The default value is v1. Default: v2 Enumeration values: v1 v2
log_config	No	FuncLogConfig object	Function log configuration.
network_controller	No	NetworkControlConfig object	Network configuration.

**Table 4** FuncVpc
Parameter	Mandatory	Type	Description
vpc_name	Yes	String	VPC name.
vpc_id	Yes	String	VPC ID.
subnet_name	Yes	String	Subnet name.
subnet_id	Yes	String	Subnet ID.
cidr	Yes	String	Subnet mask.
gateway	Yes	String	Gateway.
security_groups	No	Array of strings	Security group.

**Table 5** FuncCode
Parameter	Mandatory	Type	Description
file	No	String	Function code, which must be encoded using Base64. If this parameter is left blank, the default code is used.
link	No	String	Function code URL.

**Table 6** FuncLogConfig
Parameter	Mandatory	Type	Description
group_name	No	String	Name of the log group bound to the function.
group_id	No	String	ID of the log group bound to the function.
stream_name	No	String	Name of the log stream bound to the function.
stream_id	No	String	ID of the log stream bound to the function.

**Table 7** NetworkControlConfig
Parameter	Mandatory	Type	Description
disable_public_network	No	Boolean	Disable public access.
trigger_access_vpcs	No	Array of VpcConfig objects	VPC access restriction.

**Table 8** VpcConfig
Parameter	Mandatory	Type	Description
vpc_name	No	String	VPC name.
vpc_id	No	String	VPC ID.

Response Parameters

Status code: 200

**Table 9** Response body parameters
Parameter	Type	Description
func_urn	String	Function URN.
func_name	String	Function name.
domain_id	String	Domain ID.
namespace	String	Project ID.
project_name	String	Project name.
package	String	Group to which the function belongs. This field is defined to group functions.
runtime	String	Environment in which a FunctionGraph function is executed. Options: Python 2.7 Python 3.6 Python 3.9 Go 1.8 Go 1.x Java 8 Java 11 Node.js 6.10 Node.js 8.10 Node.js 10.16 Node.js 12.13 Node.js 14.18 C# (.NET Core 2.0) C# (.NET Core 2.1) C# (.NET Core 3.1) Custom PHP 7.3 HTTP Enumeration values: Java8 Java11 Node.js6.10 Node.js8.10 Node.js10.16 Node.js12.13 Node.js14.18 Python2.7 Python3.6 Go1.8 Go1.x C#(.NET Core 2.0) C#(.NET Core 2.1) C#(.NET Core 3.1) Custom PHP7.3 Python3.9 http
timeout	Integer	Maximum duration the function can be executed. Value range: 3s–900s. The value can be up to 12 hours for whitelisted users. For details, contact FunctionGraph personnel.
handler	String	Handler of a function in the format of "xx.xx". It must contain a period (.). For example, for Node.js function myfunction.handler, the file name is myfunction.js, and the handler function is handler.
memory_size	Integer	Memory consumed by a function. Unit: MB. The value can be 128, 256, 512, 768, 1024, 1280, 1536, 1792, 2048, 2560, 3072, 3584 or 4096. The value ranges from 128 to 4096.
gpu_memory	Integer	GPU memory. This parameter is available only for functions created with a custom runtime or image. Unit: MB. Options: 1024, 2048, 3072, 4096, 5120, 6144, 7168, 8192, 9216, 10,240, 11,264, 12,288, 13,312, 14,336, 15,360, and 16,384. Range: 1024 to 16,384.
cpu	Integer	CPU resources of a function. Unit: millicore (1 core = 1000 millicores). The value of this field is proportional to that of MemorySize. By default, 100 CPU millicores are required for 128 MB memory. The value is calculated as follows: Memory/128 x 100 + 200 (basic CPU millicores)
code_type	String	Function code type. Options: inline: inline code. zip: ZIP file. obs: function code stored in an OBS bucket. jar: JAR file, for Java functions. Enumeration values: inline zip obs jar
code_url	String	If CodeType is set to obs, enter the OBS URL of the function code package. If CodeType is not set to obs, leave this parameter blank.
code_filename	String	Name of a function file. This parameter is mandatory only when CodeType is set to jar or zip.
code_size	Long	Code size in bytes.
user_data	String	Name/Value information defined for the function. These are parameters used in a function. For example, if a function needs to access a host, define Host={host_ip}. You can define a maximum of 20 such parameters, and their total length cannot exceed 4 KB.
encrypted_user_data	String	User-defined name/value to be encrypted.
digest	String	SHA512 hash value of function code, which is used to determine whether the function has changed.
version	String	Function version, which is automatically generated by the system. The version name is in the format of "vYYYYMMDD-HHMMSS" (v+year/month/day-hour/minute/second).
image_name	String	Internal identifier of a function version.
xrole	String	Agency used by the function. You need to create an agency on the IAM console. This field is mandatory when a function needs to access other services.
app_xrole	String	Agency used by the function app. You need to create an agency on the IAM console. This field is mandatory when a function needs to access other services.
description	String	Function description.
last_modified	String	Time when the function was last updated.
func_vpc	FuncVpc object	VPC configuration.
mount_config	MountConfig object	Mounting configuration.
depend_list	Array of strings	Dependency ID list.
depend_version_list	Array of strings	Dependency versions.
strategy_config	StrategyConfig object	Function policy configuration.
extend_config	String	Extended configuration.
initializer_handler	String	Initializer of the function. It is in the format of "xx.xx" and must contain a period (.). For example, for Node.js function myfunction.initializer, the file name is myfunction.js, and the initialization function is initializer.
initializer_timeout	Integer	Maximum duration the function can be initialized. Value range: 1s–300s.
enterprise_project_id	String	Enterprise project ID. This parameter is mandatory if you create a function as an enterprise user.
enable_dynamic_memory	Boolean	Whether to enable dynamic memory allocation.
is_stateful_function	Boolean	Whether stateful functions are supported. If they are supported, set this parameter to true. This parameter is supported in FunctionGraph v2.
enable_auth_in_header	Boolean	Whether to allow authentication information in the request header.
custom_image	CustomImage object	Container image.

**Table 10** FuncVpc
Parameter	Type	Description
vpc_name	String	VPC name.
vpc_id	String	VPC ID.
subnet_name	String	Subnet name.
subnet_id	String	Subnet ID.
cidr	String	Subnet mask.
gateway	String	Gateway.
security_groups	Array of strings	Security group.

**Table 11** MountConfig
Parameter	Type	Description
mount_user	MountUser object	User information.
func_mounts	Array of FuncMount objects	Mounted resources.

**Table 12** MountUser
Parameter	Type	Description
user_id	String	User ID, a non-0 integer from –1 to 65534.
user_group_id	String	User group ID, a non-0 integer from –1 to 65534.

**Table 13** FuncMount
Parameter	Type	Description
mount_type	String	Mount type. The value can be sfs, sfsTurbo, or ecs. This parameter is mandatory when func_mounts is not empty.
mount_resource	String	ID of the mounted resource (cloud service ID). This parameter is mandatory when func_mounts is not empty.
mount_share_path	String	Remote mount path. For example, 192.168.0.12:/data. This parameter is mandatory if mount_type is set to ecs.
local_mount_path	String	Function access path. This parameter is mandatory when func_mounts is not empty.

**Table 14** StrategyConfig
Parameter	Type	Description
concurrency	Integer	Maximum number of instances for a single function. For v1, the value can be 0 or –1; for v2, it ranges from –1 to 1000. -1: The function has unlimited instances. 0: The function is disabled.
concurrent_num	Integer	Maximum number of concurrent requests per instance. This parameter is supported only by v2. The value ranges from –1 to 1000.

**Table 15** CustomImage
Parameter	Type	Description
enabled	Boolean	Whether to enable this feature.
image	String	Image address.
command	String	Command for starting a container image.
args	String	Command line parameter for starting a container image.
working_dir	String	Working directory of an image container.
uid	String	User ID of an image container.
gid	String	User group ID of an image container.

Status code: 400

**Table 16** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 401

**Table 17** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 18** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 404

**Table 19** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 20** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 503

**Table 21** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

Create a function.

POST https://{Endpoint}/v2/{project_id}/fgs/functions

{
  "func_name" : "xxx",
  "package" : "xxx",
  "runtime" : "Python2.7",
  "handler" : "index.py",
  "memory_size" : 128,
  "code_type" : "inline",
  "timeout" : 3,
  "func_code" : {
    "file" : "xxxxx",
    "link" : ""
  }
}

Example Responses

Status code: 200

{
  "func_urn" : "urn:fss:xxxxxxxxx:c3b2459a6d5e4b548e6777e57852692d:function:default:TestCreateFunctionInPythonSdk:latest",
  "func_name" : "TestCreateFunctionInPythonSdk",
  "domain_id" : "14ee2e3501124efcbca7998baa24xxxx",
  "namespace" : "46b6f338fc3445b8846c71dfb1fbxxxx",
  "project_name" : "xxxxxxxxxx",
  "package" : "default",
  "runtime" : "Python3.6",
  "timeout" : 3,
  "handler" : "index.handler",
  "memory_size" : 128,
  "cpu" : 300,
  "code_type" : "inline",
  "code_filename" : "index.py",
  "code_size" : 100,
  "digest" : "1c8610d1870731a818a037f1d2adf3223e8ac351aeb293fb1f8eabd2e9820069a61ed8b5d38182e760adc33a307d0e957afc357f415cd8c9c3ff6f0426fd85cd",
  "version" : "latest",
  "image_name" : "latest-191025153727@zehht",
  "last_modified" : "2019-10-25 15:37:27",
  "strategy_config" : {
    "concurrency" : 0
  }
}

Status code: 400

Bad request.

{
  "error_code" : "FSS.0401",
  "error_msg" : "not permit"
}

Status code: 401

Unauthorized.

{
  "error_code" : "FSS.0401",
  "error_msg" : "not permit"
}

Status code: 403

Forbidden.

{
  "error_code" : "FSS.0401",
  "error_msg" : "not permit"
}

Status Codes

Status Code	Description
200	ok
400	Bad request.
401	Unauthorized.
403	Forbidden.
404	Not found.
500	Internal server error.
503	Service unavailable.

Error Codes

See Error Codes.

Parent topic: Function Lifecycle Management

Previous topic: Querying Functions

Next topic: Deleting a Function or Function Version

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot