Querying the Execution History of a Task - ListWorkflowExecutions
Function
This API is used to query the execution history of a task.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all of the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions and Actions for details on the required permissions.
- If you are using identity policy-based authorization, no identity policy-based permissions are required for calling this API.
URI
GET /v1/{project_id}/cms/workflow/{workflow_id}/executions
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID obtained from IAM. Generally, a project ID contains 32 characters. Minimum length: 32 Maximum length: 32 |
| workflow_id | Yes | String | Task ID, which is the workflow ID obtained from the workflow command list. Minimum length: 1 Maximum length: 64 |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| x_enterprise_project_id | No | String | ID of the enterprise project. Default value: 0 Minimum length: 1 Maximum length: 64 |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | User token obtained from IAM. Minimum length: 1 Maximum length: 40960 |
| Content-Type | Yes | String | Content type, which is application/json. Minimum length: 1 Maximum length: 32 |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| [Array elements] | Array of WorkflowExecutionBrief objects | Function flow execution summary. |
| Parameter | Type | Description |
|---|---|---|
| workflow_id | String | Workflow ID. Minimum length: 1 Maximum length: 64 |
| execution_id | String | Workflow execution ID. Minimum length: 1 Maximum length: 64 |
| status | String | Flow instance execution status. Minimum length: 1 Maximum length: 32 |
| begin_time | Long | Time (UTC) when a flow instance was created. Minimum value: 0 Maximum value: 9999999999999 |
| end_time | Long | Time (UTC) when a flow instance was completed. Minimum value: 0 Maximum value: 9999999999999 |
| last_update_time | Long | Time (UTC) when a flow instance was modified. Minimum value: 0 Maximum value: 9999999999999 |
| created_by | String | Flow instance creator. Minimum length: 1 Maximum length: 32 |
| approve_user_name_list | Array of strings | Approver list. Minimum length: 1 Maximum length: 128 Array length: 0–200 |
| execution_result_list | Array of execution_result_list objects | Execution record. Array length: 1–200 |
| project_id | String | Project ID obtained from IAM. Generally, a project ID contains 32 characters. Minimum length: 32 Maximum length: 32 |
| workflow_edit_time | Long | Time (UTC) when the workflow was modified. Minimum value: 0 Maximum value: 9999999999999 |
| last_record_id_with_snapshot | String | Execution snapshot. Minimum length: 1 Maximum length: 64 |
| Parameter | Type | Description |
|---|---|---|
| node_id | String | Flow node ID. Minimum length: 1 Maximum length: 64 |
| begin_time | Long | Start time of node execution. Minimum value: 0 Maximum value: 9999999999999 |
| end_time | Long | End time of node execution. Minimum value: 0 Maximum value: 9999999999999 |
| function_execution_id | String | FunctionGraph execution ID. Minimum length: 1 Maximum length: 64 |
| output | Object | Node output. |
| status | String | Node status. Minimum length: 1 Maximum length: 32 |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Response code. Minimum length: 1 Maximum length: 64 |
| error_msg | String | Error message. Minimum length: 1 Maximum length: 1024 |
| http_code | Integer | HTTP response code. Minimum value: 0 Maximum value: 999 |
Status code: 500
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Response code. Minimum length: 1 Maximum length: 64 |
| error_msg | String | Error message. Minimum length: 1 Maximum length: 1024 |
| http_code | Integer | HTTP response code. Minimum value: 0 Maximum value: 999 |
Example Request
Query the execution history of a task with a specified workflow ID.
https://{endpoint}/v1/{project_id}/cms/workflow/{workflow_id}/executions Example Response
Status code: 200
OK: The execution history of the specified task is returned.
[ {
"approve_user_name_list" : [ ],
"begin_time" : 1600000000,
"create_by" : "xxx",
"end_time" : 1600000000,
"execution_id" : "xxxx",
"execution_result_list" : [ {
"begin_time" : 16000000,
"end_time" : 160000000,
"function_execution_id" : "xxxxx",
"node_id" : "delete-workload-pod",
"output" : {
"fail" : [ ],
"in_execution" : [ ],
"success" : [ {
"app" : "xxxxxx",
"code" : "0",
"matchLabels" : "{\"app\":\"xxxxx\",\"version\":\"xxxx\"}",
"current_project" : true,
"log" : "Restart Success.",
"replicas" : 1,
"cmdb_work_load_id" : "xxxxxxx",
"type" : "manual",
"availableReplicas" : 0,
"execute_time" : "35505",
"creationTimestamp" : " ",
"name" : "xxxxxx",
"namespace" : "default",
"cceWorkloadCluster" : "xxxxxx",
"id" : "xxxxx",
"cceWorkloadType" : "deployments"
} ],
"not_performed" : [ ]
},
"status" : "success"
} ],
"project_id" : "xxxxxxx",
"status" : "success",
"workflowEditTime" : 0,
"workflow_id" : "xxxxxxx"
} ] Status code: 401
Unauthorized: The authentication information provided by the client is incorrect or invalid.
{
"error_code" : "AOM.31009004",
"error_message" : "auth failed.",
"http_code" : "401"
} Status code: 500
Internal Server Error: The server is able to receive the request but unable to understand the request.
{
"error_code" : "AOM.31001405",
"error_msg" : "execution internal server error.",
"http_code" : 500
} SDK Sample Code
The SDK sample code is as follows:
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 | 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.aom.v1.region.AomRegion; import com.huaweicloud.sdk.aom.v1.*; import com.huaweicloud.sdk.aom.v1.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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); AomClient client = AomClient.newBuilder() .withCredential(auth) .withRegion(AomRegion.valueOf("<YOUR REGION>")) .build(); ListWorkflowExecutionsRequest request = new ListWorkflowExecutionsRequest(); request.withWorkflowId("{workflow_id}"); 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 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkaom.v1.region.aom_region import AomRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkaom.v1 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 = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = AomClient.new_builder() \ .with_credentials(credentials) \ .with_region(AomRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListWorkflowExecutionsRequest() request.workflow_id = "{workflow_id}" 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 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" aom "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v1/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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := aom.NewAomClient( aom.AomClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListWorkflowExecutionsRequest{} request.WorkflowId = "{workflow_id}" response, err := client.ListWorkflowExecutions(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in the API Explorer.
Status Code
| Status Code | Description |
|---|---|
| 200 | OK: The execution history of the specified task is returned. |
| 401 | Unauthorized: The authentication information provided by the client is incorrect or invalid. |
| 500 | Internal Server Error: The server is able to receive the request but unable to understand the request. |
Error Code
For details, see Error Codes.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot