Help Center/ FunctionGraph/ API Reference/ APIs/ Function Lifecycle Management/ Querying Functions

Updated on 2026-10-27 GMT+08:00

Querying Functions

Function

This API is used to query all functions.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

GET /v2/{project_id}/fgs/functions

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: Project ID. For details, see Obtaining a Project ID. Constraints: None Value range: 32 characters, including letters and digits. Default value: None

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
marker	No	String	Parameter description: Final record queried last time. Constraints: None Value range: An integer greater than or equal to 0 Default value: 0
maxitems	No	String	Parameter description: Maximum number of functions to obtain in a request. Constraints: None Value range: An integer greater than or equal to 0. The maximum value is 400. Default value: The default value is 400, which is used when this parameter is not specified or is 0 or greater than 400.
package_name	No	String	Parameter description: Name of the group. Constraints: None Value range: None Default value: default
func_name	No	String	Parameter description: Function name. Fuzzy search supported. Constraints: None Value range: None Default value: None
precise_search	No	Boolean	Parameter description: Whether to use exact match. After exact match is used, the parameters that support fuzzy search use exact match. Currently, the following parameters support fuzzy search: func_name Constraints: None Value range: true: exact match false: fuzzy match Default value: false

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Parameter description: User token. The token can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. Constraints: None Value range: None Default value: None
Content-Type	No	String	Parameter description: Specifies the type (or format) of the message body. Constraints: None Value range: Only application/json is supported. Default value: application/json

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
functions	Array of ListFunctionResult objects	Parameter description: Function list. Value range: None
next_marker	Long	Parameter description: Next read location. Value range: None
count	Long	Parameter description: Total number of functions that match the query conditions. Value range: None

**Table 5** ListFunctionResult
Parameter	Type	Description
resource_id	String	Parameter description: Unique ID of a function resource Value range: None
func_urn	String	Parameter description: Function URN. Value range: None
func_name	String	Parameter description: Function name. Value range: None
domain_id	String	Parameter description: Tenant account ID Value range: None
namespace	String	Parameter description: Project ID. Value range: None
project_name	String	Parameter description: Project name. Value range: None
package	String	Parameter description: Group to which the function belongs. This field is defined to group functions. Value range: None
runtime	String	Parameter description: Runtime of a FunctionGraph function, that is, the function execution environment Value range: Java8: Java 8 Java11: Java 11 Java17: Java 17 Java21: Java 21 Python2.7: Python 2.7 Python3.6: Python 3.6 Python3.9: Python 3.9 Python3.10: Python 3.10 Python3.12: Python 3.12 Go1.x: Go 1.x Node.js6.10: Nodejs 6.10 Node.js8.10: Nodejs 8.10 Node.js10.16: Nodejs 10.16 Node.js12.13: Nodejs 12.13 Node.js14.18: Nodejs 14.18 Node.js16.17: Nodejs 16.17 Node.js18.15: Nodejs 18.15 Node.js20.15: Nodejs 20.15 C#(.NET Core 2.1): C# 2.1 C#(.NET Core 3.1): C# 3.1 C#(.NET Core 6.0): C# 6.0 C#(.NET Core 8.0): C# 8.0 Custom: custom runtime PHP7.3: Php 7.3 PHP8.3: Php 8.3 Cangjie1.0 Cangjie0.52.3 HTTP Custom image-based functions
timeout	Integer	Parameter description: Maximum duration the function can be executed. Value range: 3 to 259200 seconds
handler	String	Parameter description: Handler It is in the format of "xx.xx" and must contain a period (.). The handler of a custom image function is -. For example, for Node.js function myfunction.handler, the file name is myfunction.js, and the handler function is handler. Can contain a maximum of 128 characters. Value range: 3 to 128 characters
memory_size	Integer	Parameter description: Memory (MB) consumed by the function. Value range: 128 256 512 768 1024 1280 1536 1792 2048 2560 3072 3584 4096
gpu_memory	Integer	Parameter description: GPU memory. This parameter is available only for functions created with a custom runtime or image. The unit is MB. Value range: 1024 2048 3072 4096 5120 6144 7168 8192 9216 10240 11264 12288 13312 14336 15360 16384
cpu	Integer	Parameter description: 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. Value range: None
code_type	String	Parameter description: Function code type Value range: Five values are available. 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.
code_url	String	Parameter description: 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. Value range: OBS link address
code_filename	String	Parameter description: Name of a function file. This parameter is mandatory only when CodeType is set to jar or zip. Value range: None
code_size	Long	Parameter description: Code size in bytes. Value range: None
user_data	String	Parameter description: Name/Value information defined for the function. These are parameters used in the function. For example, if a function needs to access a host, you can set a custom parameter Host={host_ip}. The total length cannot exceed 4 KB. Value range: json indicates a character string in JSON format.
encrypted_user_data	String	Parameter description: Name/value information to be encrypted. Value range: Message structure, which is a JSON string.
digest	String	Parameter description: SHA512 hash value of function code, which is used to determine whether the function is changed. Value range: None
version	String	Parameter description: 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). Value range: None
image_name	String	Parameter description: Internal identifier of a function version. Value range: None
xrole	String	Parameter description: Configuration agency. 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 configuration 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. Value range: None
app_xrole	String	Parameter description: 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. Value range: None
description	String	Parameter description: Description of the function. Value range: None
last_modified	String	Parameter description: Time when the function was last updated. Value range: UTC time.
strategy_config	StrategyConfig object	Parameter description: Function policy configuration.
status	Integer	Parameter description: Function status. Value range: 0: The function is enabled. 1: The function is disabled.
extend_config	String	Parameter description: Function extension configuration. Value range:
initializer_handler	String	Parameter description: 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 the Node.js function myfunction.initializer, the file name is myfunction.js, and the initialization input is The interface function name is initializer. Value range: None
initializer_timeout	Integer	Parameter description: Initialization timeout interval. The timeout function will be forcibly stopped. This parameter is mandatory when the initialization function is configured. Value range: [1, 300]
pre_stop_handler	String	Parameter description: 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. Value range: None
pre_stop_timeout	Integer	Parameter description: Initialization timeout interval. The timeout function will be forcibly stopped. Value range: 1 to 90 seconds
enterprise_project_id	String	Parameter description: Enterprise project ID. This parameter is mandatory if you create a function as an enterprise user. Value range: None
long_time	Boolean	Parameter description: Whether to allow a long timeout. Value range: true: Long-time timeout setting is allowed. false: Long-time timeout setting is not allowed.
log_config	LtsLogConfig object	Definition Log settings.
type	String	Parameter description: Function Version Value range: v2: official version v1: deprecated version.
fail_count	Integer	Parameter description: Number of times that a function failed to be executed in the last day. Value range: None
is_bridge_function	Boolean	Parameter description: Whether this is a bridge function. Value range: true: Yes false: no.
bind_bridge_funcUrns	Array of strings	Parameter description: URNs bound to the bridge function. Value range: None
func_vpc_id	String	Parameter description: Fields used in the function. Users do not need to pay attention to them. Value range: None

**Table 6** StrategyConfig
Parameter	Type	Description
concurrency	Integer	Parameter description: Specifies the maximum number of instances for a function. The value -1 indicates that the number of instances is not limited. Value range: v1: 0 and -1 v2: [–1, 1000]
concurrent_num	Integer	Parameter description: Specifies the number of concurrent requests per instance. This parameter is supported in v2. Value range: [1, 1000]

**Table 7** LtsLogConfig
Parameter	Type	Description
group_name	String	Definition Log group name. Range N/A
group_id	String	Definition Log group ID. Range N/A
stream_name	String	Definition Log stream name. Range N/A
stream_id	String	Definition Log stream ID. Range N/A
switch_time	Integer	Definition Timestamp of the last log stream switchover. Range Greater than or equal to 0

Status code: 401

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

Status code: 403

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

Status code: 404

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

Status code: 500

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

Example Requests

Query functions of the current tenant.

GET https://{Endpoint}/v2/{project_id}/fgs/functions?marker=0&maxitems=400

Example Responses

Status code: 200

{
  "functions" : [ {
    "func_urn" : "urn:fss:xxxxxxxxx:7aad83af3e8d42e99ac194e8419e2c9b:function:default:test",
    "resource_id" : "0d075978-5a54-4ee1-8e24-ff5bd070xxxx:test",
    "func_name" : "test",
    "domain_id" : "cff01_hk",
    "namespace" : "7aad83af3e8d42e99ac194e8419e2c9b",
    "project_name" : "xxxxxxxx",
    "package" : "default",
    "runtime" : "Node.js6.10",
    "timeout" : 3,
    "handler" : "test.handler",
    "memory_size" : 128,
    "cpu" : 100,
    "code_type" : "inline",
    "code_filename" : "index.js",
    "code_size" : 272,
    "digest" : "decbce6939297b0b5ec6d1a23bf9c725870f5e69fc338a89a6a4029264688dc26338f56d08b6535de47f15ad538e22ca66613b9a46f807d50b687bb53fded1c6",
    "version" : "latest",
    "xrole" : "cff",
    "image_name" : "latest-191025153727@zehht",
    "last_modified" : "2019-10-25 15:37:27",
    "strategy_config" : {
      "concurrency" : 0
    },
    "initializer_handler" : "index.initializer",
    "initializer_timeout" : 3,
    "pre_stop_handler" : "index.pre_stop_handler",
    "pre_stop_timeout" : 3
  } ],
  "next_marker" : 4
}

SDK Sample Code

The SDK sample code is as follows.

Java

     package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.functiongraph.v2.region.FunctionGraphRegion;
import com.huaweicloud.sdk.functiongraph.v2.*;
import com.huaweicloud.sdk.functiongraph.v2.model.*;


public class ListFunctionsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        FunctionGraphClient client = FunctionGraphClient.newBuilder()
                .withCredential(auth)
                .withRegion(FunctionGraphRegion.valueOf("<YOUR REGION>"))
                .build();
        ListFunctionsRequest request = new ListFunctionsRequest();
        try {
            ListFunctionsResponse response = client.listFunctions(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 
 
  

Python

     # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkfunctiongraph.v2.region.functiongraph_region import FunctionGraphRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkfunctiongraph.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = FunctionGraphClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(FunctionGraphRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListFunctionsRequest()
        response = client.list_functions(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 
 
  

Go

     package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    functiongraph "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/functiongraph/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/functiongraph/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/functiongraph/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := functiongraph.FunctionGraphClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := functiongraph.NewFunctionGraphClient(hcClient)

    request := &model.ListFunctionsRequest{}
	response, err := client.ListFunctions(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}
 
 
  

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code	Description
200	ok
401	Unauthorized.
403	Forbidden.
404	Not found.
500	Internal server error.

Error Codes

See Error Codes.

Parent topic: Function Lifecycle Management

Previous topic: Obtaining user feature information

Next topic: Creating a Function