更新时间:2024-06-28 GMT+08:00

获取任务执行历史

功能介绍

该接口可获取执行任务的执行历史。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户从IAM申请到的projectid,一般为32位字符串。

最小长度:32

最大长度:32

workflow_id

String

任务id,从工作流命令列表中获取的工作流id。

最小长度:1

最大长度:64

表2 Query参数

参数

是否必选

参数类型

描述

x_enterprise_project_id

String

所属的企业项目id。

缺省值:0

最小长度:1

最大长度:64

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

从IAM服务获取的用户Token。

最小长度:1

最大长度:40960

Content-Type

String

指定类型为application/json。

最小长度:1

最大长度:32

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of WorkflowExecutionBrief objects

请求响应成功,返回指定任务的执行历史。

表5 WorkflowExecutionBrief

参数

参数类型

描述

workflow_id

String

流程定义ID

最小长度:1

最大长度:64

execution_id

String

流程执行实例ID

最小长度:1

最大长度:64

status

String

流程实例执行状态

最小长度:1

最大长度:32

begin_time

Long

流程实例创建时间,格式:UTC时间戳

最小值:0

最大值:9999999999999

end_time

Long

流程实例结束时间,格式:UTC时间戳

最小值:0

最大值:9999999999999

last_update_time

Long

流程实例上次更新时间,格式:UTC时间戳

最小值:0

最大值:9999999999999

created_by

String

流程实例创建者

最小长度:1

最大长度:32

approve_user_name_list

Array of strings

审批人列表

最小长度:1

最大长度:128

数组长度:0 - 200

execution_result_list

Array of execution_result_list objects

执行记录

数组长度:1 - 200

project_id

String

租户从IAM申请到的projectid,一般为32位字符串。

最小长度:32

最大长度:32

workflow_edit_time

Long

执行工作流的修改时间,格式:UTC时间戳

最小值:0

最大值:9999999999999

last_record_id_with_snapshot

String

执行快照

最小长度:1

最大长度:64

表6 execution_result_list

参数

参数类型

描述

node_id

String

流程节点ID。

最小长度:1

最大长度:64

begin_time

Long

节点开始执行时间。

最小值:0

最大值:9999999999999

end_time

Long

节点执行结束时间。

最小值:0

最大值:9999999999999

function_execution_id

String

FunctionGraph的执行id。

最小长度:1

最大长度:64

output

Object

节点输出。

status

String

节点状态。

最小长度:1

最大长度:32

状态码: 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

响应码。

最小长度:1

最大长度:64

error_msg

String

调用失败响应信息描述。

最小长度:1

最大长度:1024

http_code

Integer

http返回码

最小值:0

最大值:999

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

响应码。

最小长度:1

最大长度:64

error_msg

String

调用失败响应信息描述。

最小长度:1

最大长度:1024

http_code

Integer

http返回码

最小值:0

最大值:999

请求示例

获取指定workflow_id的任务执行历史。

 https://{endpoint}/v1/{project_id}/cms/workflow/{workflow_id}/executions

响应示例

状态码: 200

请求响应成功,返回指定任务的执行历史。

[ {
  "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"
} ]

状态码: 401

Unauthorized。在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。

{
  "error_code" : "AOM.31009004",
  "error_message" : "auth failed.",
  "http_code" : "401"
}

状态码: 500

InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。

{
  "error_code" : "AOM.31001405",
  "error_msg" : "execution internal server error.",
  "http_code" : 500
}

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

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        AomClient client = AomClient.newBuilder()
                .withCredential(auth)
                .withRegion(AomRegion.valueOf("<YOUR REGION>"))
                .build();
        ListWorkflowExecutionsRequest request = new ListWorkflowExecutionsRequest();
        request.withXEnterpriseProjectId("<x_enterprise_project_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());
        }
    }
}
 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
# 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 = ListWorkflowExecutionsRequest()
        request.x_enterprise_project_id = "<x_enterprise_project_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)
 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
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.ListWorkflowExecutionsRequest{}
	xEnterpriseProjectIdRequest:= "<x_enterprise_project_id>"
	request.XEnterpriseProjectId = &xEnterpriseProjectIdRequest
	response, err := client.ListWorkflowExecutions(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求响应成功,返回指定任务的执行历史。

401

Unauthorized。在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。

500

InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。

错误码

请参见错误码