获取指定函数流执行实例列表 - ListWorkflowExecutions
功能介绍
获取指定函数流执行实例列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v2/{project_id}/fgs/workflows/{workflow_id}/executions
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 租户项目 ID,获取方式请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
|
workflow_id |
是 |
String |
参数解释: 函数工作流ID。 约束限制: 不涉及。 取值范围: [1, 512] 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码: 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
executions |
Array of FlowExecutionBrief objects |
流程执行信息列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
workflow_id |
String |
流程定义ID |
|
workflow_urn |
String |
函数工作流URN,格式为: urn:fss:<region_id>:<project_id>:workflow:<package>:<workflow_name>:<version> 注意: package当前只支持default version当前只支持latest |
|
execution_id |
String |
流程执行实例ID |
|
status |
String |
流程实例状态。 枚举值: |
|
begin_time |
String |
流程实例创建时间,格式:yyyy-MM-ddTHH:mm:ssZ,UTC时间 |
|
end_time |
String |
流程实例结束时间,格式:yyyy-MM-ddTHH:mm:ssZ,UTC时间 |
|
last_update_time |
String |
流程实例上次更新时间,格式:yyyy-MM-ddTHH:mm:ssZ,UTC时间 |
|
created_by |
String |
流程实例创建者 |
状态码: 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}/executions
响应示例
状态码: 200
函数流执行查询返回体
{
"executions" : [ {
"workflow_id" : "48aff955-ea10-4ffd-b426-190bc192dc14",
"workflow_urn" : "urn:fss:cn-north-7:73d69ae0cfcf460190522d060f05ad:workflow:default:testflow:latest",
"execution_id" : "48aff955-ea10-4ffd-b426-190bc192dc14",
"status" : "running",
"begin_time" : "2021-01-01T00:00:00Z",
"end_time" : "2021-01-01T00:00:00Z",
"last_update_time" : "2021-01-01T00:00:00Z",
"created_by" : "admin"
} ]
}
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 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 ListWorkflowExecutionsSolution { 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(); ListWorkflowExecutionsRequest request = new ListWorkflowExecutionsRequest(); request.withLimit(<limit>); request.withStatus(ListWorkflowExecutionsRequest.StatusEnum.fromValue("<status>")); request.withStartTime("<start_time>"); request.withEndTime("<end_time>"); try { ListWorkflowExecutionsResponse response = client.listWorkflowExecutions(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 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 = ListWorkflowExecutionsRequest() request.limit = <limit> request.status = "<status>" request.start_time = "<start_time>" request.end_time = "<end_time>" response = client.list_workflow_executions(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 36 37 38 39 40 41 42 43 |
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.ListWorkflowExecutionsRequest{} limitRequest:= int32(<limit>) request.Limit = &limitRequest statusRequest:= model.GetListWorkflowExecutionsRequestStatusEnum().<STATUS> request.Status = &statusRequest startTimeRequest:= "<start_time>" request.StartTime = &startTimeRequest endTimeRequest:= "<end_time>" request.EndTime = &endTimeRequest response, err := client.ListWorkflowExecutions(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 |
错误码
请参见错误码。