Help Center/ Application Operations Management/ API Reference/ APIs/ Automation (AOM 2.0)/ Obtaining the Execution Details of a Workflow
Updated on 2024-06-28 GMT+08:00

Obtaining the Execution Details of a Workflow

Function

This API is used to obtain the execution details of a task. You can specify the workflow ID and execution ID to query the corresponding task. The task execution details will be returned.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/cms/workflow/{workflow_id}/executions/{execution_id}/status

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

Minimum: 32

Maximum: 32

workflow_id

Yes

String

Workflow ID, which is unique and generated based on project_id and workflow_name.

Minimum: 1

Maximum: 64

execution_id

Yes

String

Workflow execution ID.

Minimum: 1

Maximum: 64

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token obtained from IAM.

Minimum: 1

Maximum: 40960

Content-Type

Yes

String

Content type, which is application/json.

Minimum: 1

Maximum: 32

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

workflow_id

String

Process definition ID.

Minimum: 1

Maximum: 64

execution_id

String

Flow instance ID.

Minimum: 1

Maximum: 64

status

String

Flow instance execution status.

Minimum: 1

Maximum: 32

begin_time

Long

Time (UTC) when a flow instance was created.

Minimum: 0

Maximum: 9999999999999

end_time

Long

Time (UTC) when a flow instance was completed.

Minimum: 0

Maximum: 9999999999999

last_update_time

Long

Time (UTC) when a flow instance was updated. Format: yyyy-MM-ddTHH:mm:ssZ.

Minimum: 0

Maximum: 9999999999999

execution_result_list

Array of execution_result_list objects

Node execution information.

Array Length: 0 - 200

approve_user_name_list

Array of strings

Approver list.

Minimum: 1

Maximum: 256

Array Length: 0 - 200

project_id

String

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

Minimum: 32

Maximum: 32

workflow_edit_time

Long

Time when the workflow was updated.

Minimum: 0

Maximum: 9999999999999

last_record_id_with_snapshot

String

Execution snapshot.

Minimum: 1

Maximum: 128

Table 4 execution_result_list

Parameter

Type

Description

node_id

String

Flow node ID.

Minimum: 1

Maximum: 64

begin_time

Long

Start time of node execution.

Minimum: 0

Maximum: 9999999999999

end_time

Long

End time of node execution.

Minimum: 0

Maximum: 9999999999999

function_execution_id

String

FunctionGraph execution ID.

Minimum: 1

Maximum: 64

output

Object

Node output.

status

String

Node status.

Minimum: 1

Maximum: 32

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Response code.

Minimum: 1

Maximum: 64

error_msg

String

Error message.

Minimum: 1

Maximum: 1024

http_code

Integer

HTTP response code.

Minimum: 0

Maximum: 999

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Response code.

Minimum: 1

Maximum: 64

error_msg

String

Error message.

Minimum: 1

Maximum: 1024

http_code

Integer

HTTP response code.

Minimum: 0

Maximum: 999

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Response code.

Minimum: 1

Maximum: 64

error_msg

String

Error message.

Minimum: 1

Maximum: 1024

http_code

Integer

HTTP response code.

Minimum: 0

Maximum: 999

Example Requests

Specify workflow_id and execution_id to obtain task details.

https://{Endpoint}/v1/{project_id}/cms/workflow/{workflow_id}/executions/{execution_id}/status

Example Responses

Status code: 200

OK: The task execution details are returned.

{
  "approve_user_name_list" : [ ],
  "begin_time" : 1670311148207,
  "end_time" : 1670311151857,
  "execution_id" : "xxxxx",
  "execution_result_list" : [ {
    "begin_time" : 1670311148207,
    "end_time" : 1670311151857,
    "function_execution_id" : "xxxxx",
    "node_id" : "run-script",
    "output" : {
      "fail" : [ {
        "availability_zone" : "cn-north-7b",
        "code" : "0",
        "error_msg" : "",
        "floating_ip_List" : [ "192.0.0.0" ],
        "charging_mode" : "0",
        "current_project" : true,
        "log" : "/usr/local/uniagentd/tmp/tmp_1670311150998271_de7b35a0-dc43-45e0-a712-d6b26844be1c: >-\n  line 1: cd: /xxx/xxx: Not a directory",
        "vpc_id" : "xxxxxx",
        "ip" : "192.0.0.0",
        "fixed_ip_list" : [ "192.0.0.0" ],
        "tags" : [ ],
        "start_time" : "1670311150773",
        "enterprise_project_id" : "0",
        "execute_time" : "130",
        "os_type" : "Linux",
        "agent_state" : "ONLINE",
        "exit_code" : "1",
        "name" : "xxxx",
        "id" : "xxxxxxxx",
        "instance_status" : "ACTIVE"
      } ],
      "in_execution" : [ ],
      "not_performed" : [ ],
      "success" : [ ]
    },
    "status" : "success"
  } ],
  "last_record_id_with_snapshot" : "xxxxxxx",
  "project_id" : "xxxxxx",
  "status" : "fail",
  "workflow_edit_time" : 1670311089444,
  "workflow_id" : "xxxxxx"
}

Status code: 400

Bad Request: Invalid request. The client should not repeat the request without modifications.

{
  "error_code" : "AOM.31001403",
  "error_message" : "param error.",
  "htp_code" : "400"
}

Status code: 401

Unauthorized: The authentication information 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_message" : "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
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 SearchWorkflowExecutionDetailSolution {

    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);

        AomClient client = AomClient.newBuilder()
                .withCredential(auth)
                .withRegion(AomRegion.valueOf("<YOUR REGION>"))
                .build();
        SearchWorkflowExecutionDetailRequest request = new SearchWorkflowExecutionDetailRequest();
        try {
            SearchWorkflowExecutionDetailResponse response = client.searchWorkflowExecutionDetail(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
# 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"]

    credentials = BasicCredentials(ak, sk)

    client = AomClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(AomRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = SearchWorkflowExecutionDetailRequest()
        response = client.search_workflow_execution_detail(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"
    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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := aom.NewAomClient(
        aom.AomClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.SearchWorkflowExecutionDetailRequest{}
	response, err := client.SearchWorkflowExecutionDetail(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 API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK: The task execution details are returned.

400

Bad Request: Invalid request. The client should not repeat the request without modifications.

401

Unauthorized: The authentication information is incorrect or invalid.

500

Internal Server Error: The server is able to receive the request but unable to understand the request.

Error Codes

See Error Codes.