获取函数列表_函数生命周期管理_API_API参考_函数工作流 FunctionGraph-华为云

功能介绍

获取函数列表

调用方法

URI

GET /v2/{project_id}/fgs/functions

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释: 租户项目 ID，获取方式请参见获取项目ID。约束限制: 不涉及。取值范围: 只能由英文字母、数字组成，且长度为32个字符。默认值: 不涉及。

表2 Query参数
参数	是否必选	参数类型	描述
marker	否	String	参数解释: 上一次查询到的最后的记录位置。约束限制: 不涉及。取值范围: 不涉及。默认值: 不涉及。
maxitems	否	String	参数解释: 每次查询获取的最大函数记录数量。约束限制: 最大值:400，如果不提供该值或者提供的值大于400或等于0，则使用默认值400 。如果该值小于0，则返回参数错误。取值范围: 不涉及。默认值: 400
package_name	否	String	参数解释: 自定义分组名称。约束限制: 不涉及。取值范围: 不涉及。默认值: 不涉及。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。约束限制: 不涉及。取值范围: 不涉及。默认值: 不涉及。
Content-Type	是	String	参数解释: 消息体的类型（格式）。约束限制: 不涉及。取值范围: 只能为application/json。默认值: application/json

响应参数

状态码: 200

表4 响应Body参数
参数	参数类型	描述
functions	Array of ListFunctionResult objects	参数解释: 函数列表。取值范围: 不涉及。
next_marker	Long	参数解释: 函数下次记录读取位置。取值范围: 不涉及。
count	Long	参数解释: 满足查询条件的函数总数。取值范围: 不涉及。

表5 ListFunctionResult
参数	参数类型	描述
resource_id	String	参数解释: 函数资源唯一标识id。取值范围: 不涉及。
func_urn	String	参数解释: 函数的URN（Uniform Resource Name），唯一标识函数。取值范围: 不涉及。
func_name	String	参数解释: 函数名称。取值范围: 不涉及。
domain_id	String	参数解释: 租户账号id。取值范围: 不涉及。
namespace	String	参数解释: 租户的project id。取值范围: 不涉及。
project_name	String	参数解释: 租户的project name。取值范围: 不涉及。
package	String	参数解释: 函数所属的分组Package，用于用户针对函数的自定义分组。取值范围: 不涉及。
runtime	String	参数解释: FunctionGraph函数的执行环境。取值范围: Java8: Java语言8版本。 Java11: Java语言11版本。 Python2.7: Python语言2.7版本。 Python3.6: Pyton语言3.6版本。 Python3.9: Python语言3.9版本。 Python3.10: Python语言3.10版本。 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版本。 C#(.NET Core 2.1): C#语言2.1版本。 C#(.NET Core 3.1): C#语言3.1版本。 Custom: 定制运行时。 PHP7.3: Php语言7.3版本。 Cangjie1.0:仓颉语言1.0版本。 Cangjie0.52.3:仓颉语言0.52.3版本。 http: HTTP函数。 Custom Image: 自定义镜像函数。
timeout	Integer	参数解释: 函数执行超时时间，超时函数将被强行停止。取值范围: 3～259200秒。
handler	String	参数解释: 函数执行入口。规则:xx.xx，必须包含“. ”；自定义镜像函数handler为“-”。举例:对于node.js函数:myfunction.handler，则表示函数的文件名为myfunction.js，执行的入口函数名为handler。长度不超过128个字符。取值范围: 最小长度为3，最大长度128字符。
memory_size	Integer	参数解释: 函数消耗的内存。单位M。取值范围为: 128 256 512 768 1024 1280 1536 1792 2048 2560 3072 3584 4096 最小值为128，最大值为4096。
gpu_memory	Integer	参数解释: 函数消耗的显存，只支持自定义运行时与自定义镜像函数配置GPU。单位MB。取值范围: 1024 2048 3072 4096 5120 6144 7168 8192 9216 10240 11264 12288 13312、 14336 15360 16384 最小值为1024，最大值为16384。
cpu	Integer	参数解释: 函数占用的cpu资源。单位为millicore（1 core=1000 millicores）。取值与MemorySize成比例，默认是128M内存占0.1个核（100 millicores）。取值范围: 不涉及。
code_type	String	参数解释: 函数代码类型。取值范围: 取值有5种。 inline: UI在线编辑代码。 zip: 函数代码为zip包。 obs: 函数代码来源于obs存储。 jar: 函数代码为jar包，主要针对Java函数。 Custom-Image-Swr: 函数代码来源与SWR自定义镜像。
code_url	String	参数解释: 当CodeType为obs时，该值为函数代码包在OBS上的地址，CodeType为其他值时，该字段为空。取值范围: obs链接地址。
code_filename	String	参数解释: 函数的文件名，当CodeType为jar/zip时必须提供该字段，inline和obs不需要提供。取值范围: 不涉及。
code_size	Long	参数解释: 函数大小，单位:字节。取值范围: 不涉及。
user_data	String	参数解释: 用户自定义的name/value信息。在函数中使用的参数。举例:如函数要访问某个主机，可以设置自定义参数:Host={host_ip}，总长度不超过4KB。取值范围: json格式的字符串。
encrypted_user_data	String	参数解释: 用户自定义的name/value信息，用于需要加密的配置。取值范围: json字符串。
digest	String	参数解释: 函数代码SHA512 hash值，用于判断函数是否变化。取值范围: 不涉及。
version	String	参数解释: 函数版本号，由系统自动生成，规则:vYYYYMMDD-HHMMSS（v+年月日-时分秒）。取值范围: 不涉及。
image_name	String	参数解释: 函数版本的内部标识。取值范围: 不涉及。
xrole	String	参数解释: 函数配置委托。需要IAM支持，并在IAM界面创建委托，当函数需要访问其他服务时，必须提供该字段。配置后用户可以通过函数执行入口方法中的context参数获取具有委托中权限的token、ak、sk，用于访问其他云服务。如果用户函数不访问任何云服务，则不用提供委托名称。取值范围: 不涉及。
app_xrole	String	参数解释: 函数执行委托。可为函数执行单独配置执行委托，这将减小不必要的性能损耗；不单独配置执行委托时，函数执行和函数配置将使用同一委托。取值范围: 不涉及。
description	String	参数解释: 函数描述。取值范围: 不涉及。
last_modified	String	参数解释: 函数最后一次更新时间。取值范围: utc时间。
func_vpc_id	String	参数解释: VPC的ID。取值范围: 不涉及。
strategy_config	StrategyConfig object	函数策略配置。
extend_config	String	参数解释: 函数扩展配置。取值范围: 不涉及。
initializer_handler	String	参数解释: 函数初始化入口，规则:xx.xx，必须包含“. ”。当配置初始化函数时，此参数必填。举例:对于node.js函数:myfunction.initializer，则表示函数的文件名为myfunction.js，初始化的入口函数名为initializer。取值范围: 不涉及。
initializer_timeout	Integer	参数解释: 初始化超时时间，超时函数将被强行停止。当配置初始化函数时，此参数必填。取值范围: 1-300秒。
pre_stop_handler	String	参数解释: 函数预停止函数的入口，规则:xx.xx，必须包含“. ”。举例:对于node.js函数:myfunction.pre_stop_handler，则表示函数的文件名为myfunction.js，初始化的入口函数名为pre_stop_handler。取值范围: 不涉及。
pre_stop_timeout	Integer	参数解释: 初始化超时时间，超时函数将被强行停止。取值范围: 1~90秒。
enterprise_project_id	String	参数解释: 企业项目ID，在企业用户创建函数时必填。取值范围: 不涉及。
long_time	Boolean	参数解释: 是否允许进行长时间超时设置。取值范围: true: 允许进行长时间超时设置。 false: 不允许进行长时间超时设置。
log_group_id	String	参数解释: 自定义日志查询组id。取值范围: 不涉及。
log_stream_id	String	参数解释: 自定义日志查询流id。取值范围: 不涉及。
type	String	参数解释: 函数版本。取值范围: v2:表示为正式版本。 v1: 为废弃版本。
fail_count	Integer	参数解释: 函数最近1天内执行失败的次数。取值范围: 不涉及。
is_bridge_function	Boolean	参数解释: 是否为bridge函数。取值范围: true:是 false:不是
bind_bridge_funcUrns	Array of strings	参数解释: 绑定bridge函数的urn列表。取值范围: 不涉及。

表6 StrategyConfig
参数	参数类型	描述
concurrency	Integer	参数解释: 单函数最大实例数。取值范围: v1取值0和-1，v2取值-1到1000 -1：代表该函数实例数无限制。 0：代表该函数被禁用。
concurrent_num	Integer	参数解释: 仅v2版本支持，单实例并发数。取值范围: 取值1到1000。

状态码: 401

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误信息

状态码: 403

表8 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误信息

状态码: 404

表9 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误信息

状态码: 500

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误信息

请求示例

当前租户函数列表。

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

响应示例

状态码: 200

ok

{
  "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" : 300,
    "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代码示例

SDK代码示例如下。

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");

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

        FunctionGraphClient client = FunctionGraphClient.newBuilder()
                .withCredential(auth)
                .withRegion(FunctionGraphRegion.valueOf("<YOUR REGION>"))
                .build();
        ListFunctionsRequest request = new ListFunctionsRequest();
        request.withMarker("<marker>");
        request.withMaxitems("<maxitems>");
        request.withPackageName("<package_name>");
        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

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

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

    try:
        request = ListFunctionsRequest()
        request.marker = "<marker>"
        request.maxitems = "<maxitems>"
        request.package_name = "<package_name>"
        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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := functiongraph.NewFunctionGraphClient(
        functiongraph.FunctionGraphClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListFunctionsRequest{}
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	maxitemsRequest:= "<maxitems>"
	request.Maxitems = &maxitemsRequest
	packageNameRequest:= "<package_name>"
	request.PackageName = &packageNameRequest
	response， err := client.ListFunctions(request)
	if err == nil {
        fmt.Printf("%+v\n"， response)
    } else {
        fmt.Println(err)
    }
}

        

      

    
   

状态码

状态码	描述
200	ok
401	Unauthorized 鉴权失败。
403	Forbidden 没有操作权限。
404	Not Found 找不到资源。
500	Internal Server Error 服务内部错误。

错误码

请参见错误码。

获取函数列表

功能介绍

调用方法

URI

请求参数

响应参数

请求示例

响应示例

SDK代码示例

Java

Python

Go

更多

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？