Querying Tasks

Function

This API is used to query the created tasks. You can query tasks by task name, task status, task type, executor, and update time.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/cms/workflow-list

Request Parameters

Response Parameters

Status code: 200

Status code: 400

Status code: 401

Status code: 500

Example Requests

Query the task list by setting Name to xxx, last_execute_by to xxx, status to xxx, task_type to xxx, and search_time_start to 1600060125000.

https://{Endpoint}/v1/{project_id}/cms/workflow-list

{
  "search" : "",
  "tags" : { },
  "page" : 0,
  "size" : 10,
  "enterprise_project_id" : "0",
  "create_by" : "xxx",
  "sort_field" : "update_time",
  "sort_type" : "DESC",
  "status" : "xxx",
  "type" : "manual",
  "search_time_start" : 160000000000,
  "search_time_end" : 160000000000
}

Example Responses

Status code: 200

OK: The task list is returned.

{
  "elements" : [ {
    "citation_urns" : [ ],
    "create_by" : "xxxx",
    "create_time" : 16000000000,
    "description" : "",
    "edit_time" : 0,
    "enterprise_project_id" : "0",
    "execution_action_rules" : [ "xxxxxxx", "xxxxxxx" ],
    "execution_permission" : [ "xxxxxxx", "xxxxxx" ],
    "id" : "xxxxxx",
    "input" : {
      "package" : {
        "cmd_user" : "xxxxx",
        "software_list" : "[xxxxxxx]",
        "pre_install_script" : "",
        "operate_type" : "install",
        "un_install_script" : "",
        "version_number" : "1",
        "time_out" : "7200",
        "install_script" : "xxxx",
        "package_version_id" : "xxxxxx",
        "package_basic_id" : "xxxxxx",
        "package_name" : "xxxxx",
        "install_file_dir" : "xxxxx",
        "plat_form" : "Linux",
        "group" : "package"
      },
      "project_id" : "xxxxxxx",
      "approve" : {
        "need_approve" : "false",
        "group" : "approve"
      },
      "region_id" : "cn-north-7",
      "get_instances" : {
        "frontend_info" : "{xxxxxx}",
        "ecs_id_list" : "[xxxxxxx]",
        "type" : "cmdb_manual",
        "group" : "ecs_instance"
      },
      "rate_control" : {
        "max" : "0",
        "timeDelay" : "0",
        "group" : "rate_control"
      }
    },
    "is_delete" : false,
    "last_execute_by" : "xxxxxx",
    "last_execution_end_time" : 1600000000,
    "last_execution_id" : "xxxxxx",
    "last_execution_start_time" : 1600000000,
    "name" : "xxxxxx",
    "nodes" : [ {
      "category" : "service",
      "description" : "download obs plug and install plug",
      "id" : "xxxxxx",
      "ignore_error" : true,
      "metadata" : {
        "configuration" : {
          "func_urn" : "xxxxxxx",
          "dataOutputPath" : "",
          "func_app" : "CMS",
          "dataInputPath" : "",
          "validator" : true,
          "func_version" : "latest",
          "dataResultsPath" : "",
          "parameters" : [ {
            "default" : "",
            "showFormat" : false,
            "format" : "",
            "value" : "root",
            "isEditor" : false,
            "key" : "properties.cmd_user"
          }, {
            "default" : "",
            "showFormat" : false,
            "format" : "",
            "value" : "[xxxxxx]",
            "isEditor" : false,
            "key" : "properties.software_list"
          }, {
            "default" : "",
            "showFormat" : false,
            "format" : "",
            "value" : "",
            "isEditor" : false,
            "key" : "properties.pre_install_script"
          }, {
            "default" : "",
            "showFormat" : false,
            "format" : "",
            "value" : "install",
            "isEditor" : false,
            "key" : "properties.operate_type"
          }, {
            "default" : "",
            "showFormat" : false,
            "format" : "",
            "value" : "",
            "isEditor" : false,
            "key" : "properties.un_install_script"
          }, {
            "default" : "",
            "showFormat" : false,
            "format" : "",
            "value" : "1",
            "isEditor" : false,
            "key" : "properties.version_number"
          }, {
            "default" : "",
            "showFormat" : false,
            "format" : "",
            "value" : "7200",
            "isEditor" : false,
            "key" : "properties.time_out"
          }, {
            "default" : "",
            "showFormat" : false,
            "format" : "",
            "value" : "xxxx",
            "isEditor" : false,
            "key" : "properties.install_script"
          }, {
            "default" : "",
            "showFormat" : false,
            "format" : "",
            "value" : "xxxxxx",
            "isEditor" : false,
            "key" : "properties.package_version_id"
          }, {
            "default" : "",
            "showFormat" : false,
            "format" : "",
            "value" : "xxxxxx",
            "isEditor" : false,
            "key" : "properties.package_basic_id"
          }, {
            "default" : "",
            "showFormat" : false,
            "format" : "",
            "value" : "xxxxx",
            "isEditor" : false,
            "key" : "properties.package_name"
          }, {
            "default" : "",
            "showFormat" : false,
            "format" : "",
            "value" : "xxxx",
            "isEditor" : false,
            "key" : "properties.install_file_dir"
          }, {
            "default" : "",
            "showFormat" : false,
            "format" : "",
            "value" : "Linux",
            "isEditor" : false,
            "key" : "properties.plat_form"
          }, {
            "default" : "",
            "showFormat" : false,
            "format" : "",
            "value" : "package",
            "isEditor" : false,
            "key" : "properties.group"
          }, {
            "default" : "",
            "showFormat" : false,
            "format" : "",
            "value" : "xxxxxx",
            "isEditor" : false,
            "key" : "properties.project_id"
          }, {
            "default" : "",
            "showFormat" : false,
            "format" : "",
            "value" : "cn-north-4",
            "isEditor" : false,
            "key" : "properties.region_id"
          }, {
            "default" : "",
            "showFormat" : false,
            "format" : "",
            "value" : "{xxxxxx}",
            "isEditor" : false,
            "key" : "properties.frontend_info"
          }, {
            "default" : "",
            "showFormat" : false,
            "format" : "",
            "value" : "[xxxxxx]",
            "isEditor" : false,
            "key" : "properties.ecs_id_list"
          }, {
            "default" : "",
            "showFormat" : false,
            "format" : "",
            "value" : "cmdb_manual",
            "isEditor" : false,
            "key" : "properties.type"
          }, {
            "default" : "",
            "showFormat" : false,
            "format" : "",
            "value" : "ecs_instance",
            "isEditor" : false,
            "key" : "properties.group"
          }, {
            "default" : "",
            "showFormat" : false,
            "format" : "",
            "value" : "0",
            "isEditor" : false,
            "key" : "properties.max"
          }, {
            "default" : "",
            "showFormat" : false,
            "format" : "",
            "value" : "0",
            "isEditor" : false,
            "key" : "properties.timeDelay"
          }, {
            "default" : "",
            "showFormat" : false,
            "format" : "",
            "value" : "rate_control",
            "isEditor" : false,
            "key" : "properties.group"
          }, {
            "default" : "",
            "showFormat" : false,
            "format" : "",
            "value" : "$.executionId",
            "isEditor" : false,
            "key" : "properties.executionId"
          }, {
            "default" : "",
            "showFormat" : false,
            "format" : "",
            "value" : "xxxxxxx",
            "isEditor" : false,
            "key" : "properties.workflowId"
          }, {
            "default" : "",
            "showFormat" : false,
            "format" : "",
            "value" : "CMS::ECS::Package",
            "isEditor" : false,
            "key" : "properties.cmsTaskName2Distribute"
          }, {
            "default" : "",
            "showFormat" : false,
            "format" : "",
            "value" : "xxxxxx",
            "isEditor" : false,
            "key" : "properties.cmsAccessPodLb"
          }, {
            "default" : "",
            "showFormat" : false,
            "format" : "",
            "value" : "manual",
            "isEditor" : false,
            "key" : "properties.workflowType"
          }, {
            "default" : "",
            "showFormat" : false,
            "format" : "",
            "value" : "package-manipulation",
            "isEditor" : false,
            "key" : "properties.nodeId"
          } ]
        },
        "type" : "operation"
      },
      "name" : "package",
      "task_name" : "CMS::ECS::Package"
    } ],
    "project_id" : "xxxxxx",
    "quote" : [ ],
    "status" : "fail",
    "steps" : [ ],
    "tags" : { },
    "task_type" : "package",
    "template_i18n" : {
      "en-us" : {
        "name" : "Package",
        "description" : "download install plug or uninstall plug"
      },
      "zh-cn" : {
        "name" : "File management",
        "description" : " "
      }
    },
    "template_id" : "CMS::ECS::Package",
    "template_name" : "CMS::ECS::Package",
    "type" : "manual",
    "update_time" : 1600000000
  } ],
  "total_elements" : 1
}

Status code: 400

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

{
  "error_code" : "AOM.31001302",
  "error_msg" : "Invalid input parameter.",
  "http_code" : 400
}

Status code: 401

Unauthorized: The authentication information is incorrect or invalid.

{
  "error_code" : "AOM.31009003",
  "error_msg" : "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.31001305",
  "error_msg" : "workflow internal server error.",
  "http_code" : 500
}

SDK Sample Code

The SDK sample code is as follows.

Java

Query the task list by setting Name to xxx, last_execute_by to xxx, status to xxx, task_type to xxx, and search_time_start to 1600060125000.

 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
50
51
52
53
54
55
56
57
58
59
60

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.*;

import java.util.Map;
import java.util.HashMap;

public class ListWorkflowSolution {

    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();
        ListWorkflowRequest request = new ListWorkflowRequest();
        WorkflowQueryParam body = new WorkflowQueryParam();
        body.withStatus("xxx");
        body.withSearchTimeEnd(160000000000L);
        body.withSearchTimeStart(160000000000L);
        body.withSortType("DESC");
        body.withSortField("update_time");
        body.withCreateBy("xxx");
        body.withEnterpriseProjectId("0");
        body.withSize(10);
        body.withPage(0);
        body.withType("manual");
        body.withSearch("");
        request.withBody(body);
        try {
            ListWorkflowResponse response = client.listWorkflow(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

Query the task list by setting Name to xxx, last_execute_by to xxx, status to xxx, task_type to xxx, and search_time_start to 1600060125000.

 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

# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

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

    try:
        request = ListWorkflowRequest()
        request.body = WorkflowQueryParam(
            status="xxx",
            search_time_end=160000000000,
            search_time_start=160000000000,
            sort_type="DESC",
            sort_field="update_time",
            create_by="xxx",
            enterprise_project_id="0",
            size=10,
            page=0,
            type="manual",
            search=""
        )
        response = client.list_workflow(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

Query the task list by setting Name to xxx, last_execute_by to xxx, status to xxx, task_type to xxx, and search_time_start to 1600060125000.

 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
50
51
52
53
54
55
56
57

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.ListWorkflowRequest{}
	statusWorkflowQueryParam:= "xxx"
	searchTimeEndWorkflowQueryParam:= int64(160000000000)
	searchTimeStartWorkflowQueryParam:= int64(160000000000)
	createByWorkflowQueryParam:= "xxx"
	enterpriseProjectIdWorkflowQueryParam:= "0"
	sizeWorkflowQueryParam:= int32(10)
	pageWorkflowQueryParam:= int32(0)
	typeWorkflowQueryParam:= "manual"
	searchWorkflowQueryParam:= ""
	request.Body = &model.WorkflowQueryParam{
		Status: &statusWorkflowQueryParam,
		SearchTimeEnd: &searchTimeEndWorkflowQueryParam,
		SearchTimeStart: &searchTimeStartWorkflowQueryParam,
		SortType: "DESC",
		SortField: "update_time",
		CreateBy: &createByWorkflowQueryParam,
		EnterpriseProjectId: &enterpriseProjectIdWorkflowQueryParam,
		Size: &sizeWorkflowQueryParam,
		Page: &pageWorkflowQueryParam,
		Type: &typeWorkflowQueryParam,
		Search: &searchWorkflowQueryParam,
	}
	response, err := client.ListWorkflow(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

Error Codes

See Error Codes.