# 查询函数流 - ListWorkflow #### 功能介绍 查询函数流 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-functiongraph/functiongraph_06_0200.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-functiongraph/functiongraph_06_1100.html)。 #### URI GET /v2/{project_id}/fgs/workflows 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**: 租户项目 ID，获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-functiongraph/functiongraph_06_0260.html)。 **约束限制**: 不涉及。 **取值范围**: 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**: 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | workflow_name | 否 | String | **参数解释**: 函数流名称。 **约束限制**: 不涉及。 **取值范围**: 不涉及。 **默认取值**: 不涉及。 | | limit | 否 | Integer | **参数解释**: 分页查询，每页显示的条目数量，默认值为200。 limit大于200时，按照200处理。 **约束限制**: 不涉及。 **取值范围**: 不涉及。 **默认取值**: 不涉及。 | | offset | 否 | Integer | **参数解释**: 分页查询，分页的偏移量，默认值为0。 offset小于0时，按照0处理。 **约束限制**: 不涉及。 **取值范围**: 不涉及。 **默认取值**: 不涉及。 | | enterprise_project | 否 | String | **参数解释**: 企业项目ID。 **约束限制**: 不涉及。 **取值范围**: 不涉及。 **默认取值**: 不涉及。 | | mode | 否 | String | **参数解释**: 函数流模式 **约束限制**: 不涉及。 **取值范围**: - NORMAL：标准函数流。 - EXPRESS：快速函数流。 **默认取值**: 不涉及。 | #### 请求参数 无 #### 响应参数 **状态码： 200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Long | **参数解释**: 所有满足条件的对象个数。 **取值范围**: 不涉及。 | | size | Integer | **参数解释**: 本次请求返回的对象个数。 **取值范围**: 不涉及。 | | workflows | Array of [WorkflowSimpleInfo] objects | **参数解释**: 返回的实体对象。 **取值范围**: 不涉及。 | 表4WorkflowSimpleInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**: 工作流ID。 **取值范围**: 不涉及。 | | workflow_urn | String | **参数解释**: 函数工作流URN，格式为： urn:fss:\:\:workflow:\:\:\ 注意： package当前只支持default version当前只支持latest **取值范围**: 不涉及。 | | name | String | **参数解释**: 工作流名称。 **取值范围**: 不涉及。 | | description | String | **参数解释**: 工作流描述。 **取值范围**: 不涉及。 | | created_time | String | **参数解释**: 工作流创建时间。 **取值范围**: 格式：yyyy-MM-ddTHH:mm:ssZ，UTC时间 | | updated_time | String | **参数解释**: 工作流修改时间。 **取值范围**: 格式：yyyy-MM-ddTHH:mm:ssZ，UTC时间 | | created_by | String | **参数解释**: 工作流创建者。 **取值范围**: 不涉及。 | | enable_stream_response | Boolean | **参数解释**: 工作流是否支持stream返回。 **取值范围**: 不涉及。 | **状态码： 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 | #### 请求示例 查询函数流。 ``` 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" } ] } ``` #### 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 ListWorkflowSolution { 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("")) .build(); ListWorkflowRequest request = new ListWorkflowRequest(); request.withWorkflowName(""); request.withLimit(); request.withOffset(); request.withEnterpriseProject(""); request.withMode(""); try { ListWorkflowResponse response = client.listWorkflow(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("")) \ .build() try: request = ListWorkflowRequest() request.workflow_name = "" request.limit = request.offset = request.enterprise_project = "" request.mode = "" response = client.list_workflow(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("")). WithCredential(auth). Build()) request := &model.ListWorkflowRequest{} workflowNameRequest:= "" request.WorkflowName = &workflowNameRequest limitRequest:= int32() request.Limit = &limitRequest offsetRequest:= int32() request.Offset = &offsetRequest enterpriseProjectRequest:= "" request.EnterpriseProject = &enterpriseProjectRequest modeRequest:= "" request.Mode = &modeRequest response, err := client.ListWorkflow(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` #### 更多 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/FunctionGraph/sdk?api=ListWorkflow)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 函数流查询返回体 | | 400 | Bad Request | | 500 | Internal Server Error | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-functiongraph/ErrorCode.html)。