文档首页/ 函数工作流 FunctionGraph/ API参考/ API/ 函数流/ 获取指定元数据components列表
更新时间:2025-07-11 GMT+08:00
分享

获取指定元数据components列表

功能介绍

获取指定元数据components列表

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/ffs/metadata/components

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

租户项目 ID,获取方式请参见获取项目ID

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为32个字符

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

locale

String

locale

type

String

type

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

components

Object

组件元素

表4 ComponentsItem

参数

参数类型

描述

type

String

类型

categories

Array of objects

所属元数据种类

display

String

展示名称

width

String

宽度

description

String

描述

tags

Array of objects

所属标签种类

inputs

Array of objects

输入界面构造元素

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

request_id

String

请求ID

状态码:500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

request_id

String

请求ID

请求示例

响应示例

状态码:200

指定元数据components列表

{
  "components" : [ {
    "type" : "start_node",
    "categories" : [ "processors" ],
    "display" : "开始",
    "width" : "700px",
    "description" : "Start Node",
    "tags" : [ "api_flow" ],
    "inputs" : [ ]
  } ]
}

状态码

状态码

描述

200

指定元数据components列表

400

Bad Request

500

Internal Server Error

错误码

请参见错误码

相关文档