文档首页> 函数工作流 FunctionGraph> API参考> API> 函数模板> 获取函数模板列表
更新时间：2024-03-14 GMT+08:00
查看PDF

获取函数模板列表

功能介绍

获取函数模板列表

URI

GET /v2/{project_id}/fgs/templates

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目 ID，获取方式请参见获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

marker

否

String

本次查询起始位置，默认值0

缺省值：0

最小长度：1

最大长度：64

maxitems

否

String

每次查询获取的最大模板数量。

ispublic

否

String

是否为公开模板

runtime

否

String

指定运行时模板

scene

否

String

指定场景模板

service

否

String

指定云服务模板

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

Content-Type

是

String

消息体的类型（格式）

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

func_templates

Array of ShowFunctionTemplateResponseBody objects

函数模板列表

next_marker

Integer

函数下次记录读取位置。
表5 ShowFunctionTemplateResponseBody

参数

参数类型

描述

id

String

模板id

type

Integer

模板类型

title

String

模板标题

template_name

String

模板名称

description

String

模板描述

runtime

String

模板执行运行时

handler

String

模板函数执行入口

code_type

String

代码类型

code

String

代码文件

timeout

Integer

函数执行超时时间，超时函数将被强行停止，范围3～259200秒。

memory_size

Integer

内存大小

trigger_metadata_list

Array of TriggerMetadataList objects

触发信息列表

temp_detail

TempDetail object

user_data

String

用户数据

encrypted_user_data

String

加密用户数据

dependencies

Array of strings

模板所需依赖列表

scene

String

模板使用场景

service

String

模板关联云服务
表6 TriggerMetadataList

参数

参数类型

描述

trigger_name

String

触发名称

trigger_type

String

触发器类型

event_type

String

事件类型

event_data

String

事件数据
表7 TempDetail

参数

参数类型

描述

input

String

模板输入

output

String

模板输出

warning

String

警告信息

状态码： 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码： 401

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码： 403

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码： 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

获取500个公开函数模板列表。

GET /v2/{project_id}/fgs/templates?marker=0&maxitems=500&ispublic=true

响应示例

状态码： 200

OK

{
  "func_templates" : [ {
    "id" : "d3aa6e4c-xxxx-xxxx-9c09-5c50c4xxxxxx",
    "type" : 1,
    "title" : "access-service-with-http",
    "template_name" : "access-service-with-http-php",
    "description" : "access service with http.",
    "runtime" : "PHP7.3",
    "handler" : "index.handler",
    "code_type" : "inline",
    "code" : "xxxxx",
    "timeout" : 30,
    "memory_size" : 256,
    "trigger_metadata_list" : [ ],
    "temp_detail" : {
      "input" : "None",
      "output" : "execution succeed: Return to access service information through http/https,",
      "warning" : "1. configure the serveraddress environment variables."
    },
    "user_data" : "",
    "encrypted_user_data" : "",
    "dependencies" : [ ],
    "scene" : "basic_function_usage",
    "service" : "FunctionGraph"
  } ],
  "next_marker" : 1
}

状态码

状态码

描述

200

OK

400

Bad Request 请求错误。

401

Unauthorized 鉴权失败。

403

Forbidden 没有操作权限。

500

Internal Server Error 服务内部错误。

错误码

请参见错误码。

父主题： 函数模板