获取指定函数流实例的元数据
功能介绍
获取指定函数流实例的元数据
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/fgs/workflows/{workflow_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 租户项目 ID,获取方式请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符 默认取值: 不涉及。 |
workflow_id |
是 |
String |
参数解释: 函数工作流ID。 约束限制: 不涉及。 取值范围: [1, 512] 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 唯一标识ID,流程定义ID。 取值范围: 不涉及。 |
workflow_urn |
String |
参数解释: 函数工作流URN,格式为: urn:fss:<region_id>:<project_id>:workflow:<package>:<workflow_name>:<version> 注意: package当前只支持default。 version当前只支持latest。 取值范围: 不涉及。 |
created_time |
String |
参数解释: 流程创建时间,格式:yyyy-MM-ddTHH:mm:ssZ。 取值范围: UTC时间 |
updated_time |
String |
参数解释: 流程修改时间,格式:yyyy-MM-ddTHH:mm:ssZ。 取值范围: UTC时间 |
created_by |
String |
参数解释: 流程创建者。 取值范围: 不涉及。 |
lts_group_id |
String |
参数解释: 快速函数流日志组ID。 取值范围: 不涉及。 |
lts_stream_id |
String |
参数解释: 快速函数流日志流ID。 取值范围: 不涉及。 |
definition |
WorkflowCreateBody object |
参数解释: FunctionGraph工作流创建body体。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: FunctionGraph工作流名称。 约束限制: ^([_a-zA-Z0-9().-]|[\u4e00-\u9fa5]){1,64}$ 取值范围: [1, 64] 默认取值: 不涉及。 |
description |
String |
参数解释: FunctionGraph工作流描述。 约束限制: ^([_a-zA-Z0-9().-]|[\u4e00-\u9fa5]){1,512}$ 取值范围: [1, 512] 默认取值: 不涉及。 |
start |
String |
参数解释: FunctionGraph工作流开始节点ID。 约束限制: 不涉及。 取值范围: [1, 256] 默认取值: 不涉及。 |
triggers |
Array of Trigger objects |
参数解释: FunctionGraph工作流触发器列表。 约束限制: 不涉及。 取值范围: [0, 200] 默认取值: 不涉及。 |
functions |
Array of Function objects |
参数解释: FunctionGraph工作流函数列表。 约束限制: 不涉及。 取值范围: [0, 100] 默认取值: 不涉及。 |
states |
Array of OperationState objects |
参数解释: FunctionGraph工作流节点列表。 约束限制: 不涉及。 取值范围: [1, 100] 默认取值: 不涉及。 |
constants |
Object |
参数解释: FunctionGraph工作流常量。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
retries |
Array of Retry objects |
参数解释: FunctionGraph工作流重试策略列表。 约束限制: 不涉及。 取值范围: [0, 200] 默认取值: 不涉及。 |
mode |
String |
参数解释: FunctionGraph工作流模式,默认标准模式。 约束限制: 不涉及。 取值范围: 默认取值: NORMAL |
express_config |
ExpressConfig object |
参数解释: 快速函数流模式配置,当mode为EXPRESS时需要设置。 默认取值: 不涉及。 |
enterprise_project_id |
String |
参数解释: FunctionGraph工作流企业项目。 约束限制: 不涉及。 取值范围: [0, 64] 默认取值: 不涉及。 |
enable_stream_response |
Boolean |
参数解释: FunctionGraph工作流是否支持流式返回。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: false |
参数 |
参数类型 |
描述 |
---|---|---|
trigger_name |
String |
参数解释: 触发器名称。 取值范围: 不涉及。 |
trigger_type |
String |
参数解释 触发器类型。 取值范围 |
enabled |
Boolean |
参数解释: 是否启用触发器。 取值范围: 不涉及。 |
trigger_config |
OBSTriggerConfig object |
参数解释: OBS触发器配置。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
bucket |
String |
参数解释: OBS桶名(trigger_type为OBS时配置)。 取值范围: 不涉及。 |
events |
Array of strings |
参数解释: OBS事件列表(trigger_type为OBS时配置)。 取值范围: 不涉及。 |
prefix |
String |
参数解释: OBS对象名前缀(trigger_type为OBS时配置)。 取值范围: 不涉及。 |
suffix |
String |
参数解释: OBS对象名后缀(trigger_type为OBS时配置)。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: 函数名称,在单个流程中,名称需要唯一。 取值范围: 不涉及。 |
operation |
String |
参数解释: 函数调用URN。 取值范围: 不涉及。 |
metadata |
Object |
参数解释: 函数扩展信息, 由用户自己定制。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
action_mode |
String |
参数解释: 节点执行模式。 取值范围: |
actions |
Array of Action objects |
参数解释: 节点执行操作列表。 取值范围: 不涉及。 |
on_errors |
Array of OnError objects |
参数解释: 节点执行错误处理策略列表。 取值范围: 不涉及。 |
id |
String |
参数解释: 节点ID,工作流中唯一。 取值范围: 不涉及。 |
name |
String |
参数解释: 节点名称。 取值范围: 不涉及。 |
type |
String |
参数解释: 节点类型表。 取值范围: |
end |
Boolean |
参数解释: 是否是结束节点。 取值范围: 不涉及。 |
transition |
String |
参数解释: 下一节点ID。 取值范围: 不涉及。 |
state_data_filter |
StateDataFilter object |
参数解释: 过滤表达式。 取值范围: 不涉及。 |
duration |
Long |
参数解释: 时间等待节点等待时间(秒),节点类型为Sleep时为必填,节点类型不为Sleep时无效。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
ref_name |
String |
参数解释: 函数引用名称, 需要和外层functions中的name对应。 取值范围: 不涉及。 |
invoke_mode |
String |
参数解释: 函数调用模式, 目前只支持同步调用。 取值范围: |
arguments |
Object |
参数解释 函数执行时的入参,支持引用constants中的常量。 定义方式:参数路径 | 常量值/常量路径 参数路径指输入参数的JsonPath路径,如$.a.b[0].c 常量值可以为数字类型,字符串类型(需要用单引号括起来),布尔类型 常量路径为常量的JsonPath路径,但是根节点需要用$CONST表示,示例:$CONST.a.b 取值范围 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
error |
String |
参数解释: 错误匹配表达式,用来过滤需要处理的异常。 取值范围: 不涉及。 |
transition |
String |
参数解释: 下一步骤节点ID。 取值范围: 不涉及。 |
retry_ref |
String |
参数解释: 重试策略名称。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
input |
String |
参数解释: 输入过滤表达式(JsonPath)。 取值范围: 不涉及。 |
output |
String |
参数解释: 输出过滤表达式(JsonPath)。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: 重试策略名称,在单个流程中,名称需要唯一。 取值范围: 不涉及。 |
delay |
Long |
参数解释: 重试间隔,单位:秒。若不传,默认为1。 取值范围: 不涉及。 |
max_attempts |
Long |
参数解释: 最大重试次数,若不传,默认为3。 取值范围: 不涉及。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
request_id |
String |
请求ID |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
request_id |
String |
请求ID |
请求示例
获取函数流id为{workflow_id}的函数流元数据。
GET /v2/{project_id}/fgs/workflows/{workflow_id}
响应示例
状态码: 200
OK
{
"id" : "fa466a62-73a2-49b9-9261-358dfe873b6e",
"created_time" : "2022-09-01T01:29:46Z",
"updated_time" : "2022-09-13T07:27:02Z",
"workflow_urn" : "urn:fss:cn-north-7:c53626012ba84727b938ca8bf03108ef:workflow:default:flow_nxy:latest",
"lts_group_id" : "124cef5b-d494-490d-af94-166c4bef0e0d",
"lts_stream_id" : "07e89ef7-d038-4018-97de-167b255de61f"
}
SDK代码示例
SDK代码示例如下。
Java
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 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 ShowWorkFlowSolution {
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();
ShowWorkFlowRequest request = new ShowWorkFlowRequest();
try {
ShowWorkFlowResponse response = client.showWorkFlow(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
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 |
# 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 = ShowWorkFlowRequest()
response = client.show_work_flow(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
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 |
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.ShowWorkFlowRequest{}
response, err := client.ShowWorkFlow(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
500 |
Internal Server Error |
错误码
请参见错误码。