Querying the Metadata of a Function

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.

function_urn

Yes

String

Function URN. For details, see the function model 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.

Content-Type

Yes

String

Message body type (format).

func_id

String

Function ID, which uniquely identifies a function.

resource_id

String

Resource ID.

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 for executing a function. Options: Python2.7 Python 3.6 Python 3.9 Python 3.10 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 Node.js 16.17 Node.js 18.15 C# (.NET Core 2.1) C# (.NET Core 3.1) Custom PHP 7.3 HTTP Custom image-based functions Cangjie1.0

Enumeration values:

• Java8
• Java11
• Node.js6.10
• Node.js8.10
• Node.js10.16
• Node.js12.13
• Node.js14.18
• Node.js16.17
• Node.js18.15
• Python2.7
• Python3.6
• Python3.10
• Go1.x
• C#(.NET Core 2.1)
• C#(.NET Core 3.1)
• Custom
• PHP7.3
• Python3.9
• http
• Custom Image
• Cangjie1.0

timeout

Integer

Maximum duration the function can be executed. Value range: 3s–259,200s.

handler

String

Handler of a function in the format of "xx.xx". Max. 60 of letters. 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.

Minimum length: 3 character.

Maximum length: 128 characters.

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.

code_type

String

Function code type. Options: inline: inline code zip: ZIP file obs: function code stored in an OBS bucket jar: JAR file, mainly for Java functions Custom-Image-Swr: The function code comes from the SWR custom image.

Enumeration values:

• inline
• zip
• obs
• jar
• Custom-Image-Swr

code_url

String

If code_type is set to obs, enter the OBS URL of the function code package. If code_type is not set to obs, leave this parameter blank.

code_filename

String

Name of a function file. This parameter is mandatory only when code_type 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 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.

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. After specifying a function execution agency, you can use the context method in the function handler to obtain a token, an AK, and an SK for accessing other cloud services. No agency is required if FunctionGraph does not access any cloud services.

app_xrole

String

Execution agency. You can optimize performance by configuring a separate agency for function execution, otherwise, the same agency is used for both execution and configuration.

description

String

Function description.

last_modified

String

Time when the function was last updated.

ephemeral_storage

Integer

Ephemeral storage. By default, the /tmp directory of each function is 512 MB. You can increase the size to 10,240 MB (10 GB) if necessary.

Enumeration values:

• 512
• 10240

func_vpc

FuncVpc object

VPC configuration. An agency with VPC permissions must be configured for the function.

mount_config

MountConfig object

Mounting configuration.

depend_list

Array of strings

Dependency ID list.

depend_version_list

Array of strings

Dependency version IDs.

strategy_config

StrategyConfig object

Function policy configuration.

dependencies

Array of Dependency objects

Dependency packages.

initializer_handler

String

Initializer of the function in the format of "xx.xx". It must contain a period (.). This parameter is mandatory when the initialization function is configured. 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. This parameter is mandatory when the initialization function is configured.

pre_stop_handler

String

The pre-stop handler of a function. The value must contain a period (.) in the format of xx.xx. For example, for Node.js function myfunction.pre_stop_handler, the file name is myfunction.js, and the initialization function is pre_stop_handler.

pre_stop_timeout

Integer

Maximum duration the function can be initialized. Value range: 1s–90s.

enterprise_project_id

String

Enterprise project ID. This parameter is mandatory if you create a function as an enterprise user.

long_time

Boolean

Whether to allow a long timeout.

log_group_id

String

Log group ID.

log_stream_id

String

Log stream ID.

type

String

v2 indicates an official version, and v1 indicates a deprecated version.

Enumeration values:

• v1
• v2

enable_cloud_debug

String

Whether to enable cloud debugging to adapt to the CloudDebug scenario. (discarded)

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.

is_bridge_function

Boolean

Whether this is a bridge function.

enable_auth_in_header

Boolean

Whether to add authentication information to request header for custom image-based functions.

custom_image

CustomImage object

Container image.

reserved_instance_idle_mode

Boolean

Whether to enable idle mode for reserved instances.

apig_route_enable

Boolean

Whether to configure gateway routing rules.

heartbeat_handler

String

Entry of the heartbeat function in the format of "xx.xx". It must contain a period (.).This parameter can be configured only in Java. The heartbeat function entry must be in the same file as your function handler. This parameter is mandatory when the heartbeat function is enabled.

enable_class_isolation

Boolean

Indicates whether to enable class isolation. This parameter can be configured only in Java. Enable to dump logs to Kafka and improve class loading efficiency. However, this may cause compatibility issues.

gpu_type

String

GPU type.

allow_ephemeral_storage

Boolean

Indicates whether ephemeral storage can be configured.

network_controller

NetworkControlConfig object

Network configuration.

is_return_stream

Boolean

Whether to return stream data. (discarded)

domain_id

String

Domain name ID.

namespace

String

Project ID.

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.

mount_user

MountUser object

User information.

func_mounts

Array of FuncMount objects

Mounted resources.

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.

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.

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

Number of concurrent requests per instance. This parameter is supported only by v2. The value ranges from 1 to 1,000.

id

String

Dependency version ID.

owner

String

Domain ID of the dependency owner.

link

String

URL of the dependency on OBS.

runtime

String

Environment for executing a function. Options: Python2.7 Python 3.6 Python 3.9 Python 3.10 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 Node.js 16.17 Node.js 18.15 C# (.NET Core 2.1) C# (.NET Core 3.1) Custom PHP 7.3 HTTP Custom image-based functions Cangjie1.0

Enumeration values:

• Java8
• Java11
• Node.js6.10
• Node.js8.10
• Node.js10.16
• Node.js12.13
• Node.js14.18
• Node.js16.17
• Node.js18.15
• Python2.7
• Python3.6
• Python3.10
• Go1.x
• C#(.NET Core 2.1)
• C#(.NET Core 3.1)
• Custom
• PHP7.3
• Python3.9
• http
• Custom Image
• Cangjie1.0

etag

String

MD5 value of a dependency.

size

Long

Dependency size.

name

String

Dependence name.

description

String

Dependency description.

file_name

String

File name of a dependency package (ZIP).

version

Long

Dependency version ID.

dep_id

String

Dependency ID.

last_modified

Integer

Time when the function was last updated.

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.

disable_public_network

Boolean

Disable public access.

trigger_access_vpcs

Array of VpcConfig objects

VPC access restriction.

vpc_name

String

VPC name.

vpc_id

String

VPC ID.

error_code

String

Error code.

error_msg

String

Error message.

error_code

String

Error code.

error_msg

String

Error message.

error_code

String

Error code.

error_msg

String

Error message.

error_code

String

Error code.

error_msg

String

Error message.

error_code

String

Error code.

error_msg

String

Error message.

200

OK

400

Bad request.

401

Unauthorized.

403

Forbidden.

404

Not found.

500

Internal server error.