功能介绍
查询函数流
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/fgs/workflows
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见获取项目ID。 最小长度:1 最大长度:64 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
workflow_name |
否 |
String |
函数流名称 最小长度:0 最大长度:64 |
limit |
否 |
Integer |
分页查询,每页显示的条目数量,默认值为200 limit大于200时,按照200处理 最小值:1 |
offset |
否 |
Integer |
分页查询,分页的偏移量,默认值为0 offset小于0时,按照0处理 最小值:0 |
ent erp rise_project |
否 |
String |
企业项目ID |
mode |
否 |
String |
函数流模式 "NORMAL"标准函数流 "EXPRESS"快速函数流 |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total |
Long |
返回所有满足条件的对象个数 最小值:0 最大值:1000000 |
size |
Integer |
返回对象的大小 最小值:0 最大值:200 |
workflows |
返回的实体对象 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
唯一标识ID,流程定义ID 最小长度:1 最大长度:64 |
workflow_urn |
String |
函数工作流 URN, 格式为:urn:fss:<region_id>:<project_id>:workflow:<package>:<workflow_name>:<version>注意:package当前只支持defaultversion当前只支持latest |
name |
String |
流程定义名称 最小长度:1 最大长度:64 |
description |
String |
流程定义描述 最小长度:0 最大长度:512 |
created_time |
String |
流程创建时间,格式:yyyy-MM-ddTHH:mm:ssZ,UTC时间 最小长度:0 最大长度:64 |
updated_time |
String |
流程修改时间,格式:yyyy-MM-ddTHH:mm:ssZ,UTC时间 最小长度:0 最大长度:64 |
created_by |
String |
流程创建者 最小长度:0 最大长度:64 |
enable_stream_response |
Boolean |
是否返回流数据 缺省值:false |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:1 最大长度:36 |
error_msg |
String |
错误描述 最小长度:2 最大长度:512 |
request_id |
String |
请求ID 最小长度:2 最大长度:512 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:1 最大长度:36 |
error_msg |
String |
错误描述 最小长度:2 最大长度:512 |
request_id |
String |
请求ID 最小长度:2 最大长度:512 |
请求示例
查询函数流列表。
GET /v2/{project_id}/fgs/workflows
响应示例
状态码: 200
函数流查询返回体
{ "total" : 1, "size" : 1, "workflows" : [ { "id" : "48aff955-ea10-4ffd-b426-190bc192dc14", "workflow_urn" : "urn:fss:cn-north-7:73d69ae0cfcf460190522d060f05ad:workflow:default:testflow:latest", "name" : "test-flow", "description" : "desc", "created_time" : "2021-01-01T00:00:00Z", "updated_time" : "2021-01-01T00:00:00Z", "created_by" : "admin" } ] }
状态码
状态码 |
描述 |
---|---|
200 |
函数流查询返回体 |
400 |
Bad Request |
500 |
Internal Server Error |
错误码
请参见错误码。