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

同步执行工作流

功能介绍

以同步执行方式启动工作流(仅快速模式工作流支持),暂不支持国际站局点调用

调用方法

请参见如何调用API

URI

POST /v2/{project_id}/fgs/workflows/{workflow_id}/sync-executions

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

最小长度:1

最大长度:64

workflow_id

String

工作流定义ID

最小长度:1

最大长度:512

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

headers

Object

执行时需要的Header

input

Object

定义执行时的入参,支持使用JSONPATH进行映射,以及指定默认值

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

execution_id

String

流程实例ID

最小长度:1

最大长度:64

status

String

流程执行最终状态

最小长度:1

最大长度:64

枚举值:

  • success

  • fail

  • timeout

output

Object

工作流的执行结果,JSON格式,仅在status为success时有值

errors

Array of SyncExecutionNodeErrorDetail objects

流程执行错误信息,仅在status为fail时有值

数组长度:0 - 200

begin_time

String

流程实例创建时间,格式:yyyy-MM-ddTHH:mm:ssZ,UTC时间

最小长度:0

最大长度:64

end_time

String

流程实例结束时间,格式:yyyy-MM-ddTHH:mm:ssZ,UTC时间

最小长度:0

最大长度:64

表4 SyncExecutionNodeErrorDetail

参数

参数类型

描述

node_id

String

流程节点ID

最小长度:1

最大长度:64

error_message

String

错误详细信息

最小长度:1

最大长度:2048

begin_time

String

流程实例创建时间,格式:yyyy-MM-ddTHH:mm:ssZ,UTC时间

最小长度:0

最大长度:64

end_time

String

流程实例结束时间,格式:yyyy-MM-ddTHH:mm:ssZ,UTC时间

最小长度:0

最大长度:64

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

状态码: 404

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

请求示例

同步执行工作流。

POST /{project_id}/fgs/workflows/{workflow_id}/sync-executions

{
  "headers" : {
    "tenantId" : "user1"
  },
  "input" : {
    "arg1" : "argument_1",
    "arg2" : "argument_2"
  }
}

响应示例

状态码: 200

Success

{
  "execution_id" : "48aff955-ea10-4ffd-b426-190bc192dc14",
  "status" : "success",
  "output" : {
    "result" : 200,
    "message" : "success"
  },
  "errors" : [ {
    "node_id" : "48aff955-ea10-4ffd-b426-190bc192dc14",
    "error_message" : "Exception happened",
    "begin_time" : "2021-01-01T00:00:00Z",
    "end_time" : "2021-01-01T00:00:00Z"
  } ],
  "begin_time" : "2021-01-01T00:00:00Z",
  "end_time" : "2021-01-01T00:00:00Z"
}

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
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 StartSyncWorkflowExecutionSolution {

    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();
        StartSyncWorkflowExecutionRequest request = new StartSyncWorkflowExecutionRequest();
        FlowExecuteBody body = new FlowExecuteBody();
        body.withInput("{\"arg2\":\"argument_2\",\"arg1\":\"argument_1\"}");
        body.withHeaders("{\"tenantId\":\"user1\"}");
        request.withBody(body);
        try {
            StartSyncWorkflowExecutionResponse response = client.startSyncWorkflowExecution(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
# 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 = StartSyncWorkflowExecutionRequest()
        request.body = FlowExecuteBody(
            input="{\"arg2\":\"argument_2\",\"arg1\":\"argument_1\"}",
            headers="{\"tenantId\":\"user1\"}"
        )
        response = client.start_sync_workflow_execution(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
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.StartSyncWorkflowExecutionRequest{}
	var inputFlowExecuteBody interface{} = "{\"arg2\":\"argument_2\",\"arg1\":\"argument_1\"}"
	var headersFlowExecuteBody interface{} = "{\"tenantId\":\"user1\"}"
	request.Body = &model.FlowExecuteBody{
		Input: &inputFlowExecuteBody,
		Headers: &headersFlowExecuteBody,
	}
	response, err := client.StartSyncWorkflowExecution(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

Success

400

Bad Request

404

Bad Request

500

Internal Server Error

错误码

请参见错误码

相关文档