更新时间:2024-03-21 GMT+08:00
分享

查询函数流

功能介绍

查询函数流

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/fgs/workflows

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

最小长度:1

最大长度:64

表2 Query参数

参数

是否必选

参数类型

描述

workflow_name

String

函数流名称

最小长度:0

最大长度:64

limit

Integer

分页查询,每页显示的条目数量,默认值为200 limit大于200时,按照200处理

最小值:1

offset

Integer

分页查询,分页的偏移量,默认值为0 offset小于0时,按照0处理

最小值:0

enterprise_project

String

企业项目ID

mode

String

函数流模式 "NORMAL"标准函数流 "EXPRESS"快速函数流

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

total

Long

返回所有满足条件的对象个数

最小值:0

最大值:1000000

size

Integer

返回对象的大小

最小值:0

最大值:200

workflows

Array of WorkflowSimpleInfo objects

返回的实体对象

数组长度:0 - 200

表4 WorkflowSimpleInfo

参数

参数类型

描述

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

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

request_id

String

请求ID

最小长度:2

最大长度:512

状态码: 500

表6 响应Body参数

参数

参数类型

描述

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"
  } ]
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
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("<YOUR REGION>"))
                .build();
        ListWorkflowRequest request = new ListWorkflowRequest();
        request.withWorkflowName("<workflow_name>");
        request.withLimit(<limit>);
        request.withOffset(<offset>);
        request.withEnterpriseProject("<enterprise_project>");
        request.withMode("<mode>");
        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());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# 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 = ListWorkflowRequest()
        request.workflow_name = "<workflow_name>"
        request.limit = <limit>
        request.offset = <offset>
        request.enterprise_project = "<enterprise_project>"
        request.mode = "<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)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
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.ListWorkflowRequest{}
	workflowNameRequest:= "<workflow_name>"
	request.WorkflowName = &workflowNameRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	enterpriseProjectRequest:= "<enterprise_project>"
	request.EnterpriseProject = &enterpriseProjectRequest
	modeRequest:= "<mode>"
	request.Mode = &modeRequest
	response, err := client.ListWorkflow(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

函数流查询返回体

400

Bad Request

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品