Help Center> SecMaster> API Reference> API> Workflow Management> Querying the Workflow List
Updated on 2024-03-20 GMT+08:00

Querying the Workflow List

Function

This API is used to query the workflow list.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/workspaces/{workspace_id}/soc/workflows

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Minimum: 32

Maximum: 36

workspace_id

Yes

String

Workspace ID

Minimum: 32

Maximum: 36

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Number

Offset

Minimum: 0

Maximum: 999999999

Default: 0

limit

No

Number

Data volume

Minimum: 1

Maximum: 100

Default: 10

order

No

String

Sorting sequence, including asc for ascending order and desc for descending order.

Minimum: 0

Maximum: 4

Enumeration values:

  • asc

  • desc

sortby

No

String

Sorting fields, including create_time for creation time and category for classification name.

Minimum: 2

Maximum: 32

Enumeration values:

  • category

  • create_time

enabled

No

Boolean

Whether to enable.

last_version

No

Boolean

Latest version.

name

No

String

Workflow name.

Minimum: 1

Maximum: 64

description

No

String

Description

Minimum: 1

Maximum: 512

dataclass_id

No

String

Data class ID.

Minimum: 1

Maximum: 64

dataclass_name

No

String

Data class name.

Minimum: 1

Maximum: 64

aop_type

No

String

Process Type

Minimum: 1

Maximum: 64

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

Minimum: 0

Maximum: 2097152

content-type

Yes

String

Content type.

Default: application/json;charset=UTF-8

Minimum: 0

Maximum: 64

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID, in the format request_uuid-timestamp-hostname.

Table 5 Response body parameters

Parameter

Type

Description

code

String

Return code.

Minimum: 0

Maximum: 1000

total

Integer

Total records.

Minimum: 0

Maximum: 1000

offset

Integer

Current page size.

Minimum: 0

Maximum: 1000

limit

Integer

Current page.

Minimum: 0

Maximum: 1000

message

String

Request ID

Minimum: 32

Maximum: 36

success

Boolean

Successful or not.

data

Array of AopWorkflowInfo objects

Workflow list.

Array Length: 0 - 100

Table 6 AopWorkflowInfo

Parameter

Type

Description

id

String

Workflow ID.

Minimum: 32

Maximum: 64

name

String

Workflow name.

Minimum: 0

Maximum: 1024

description

String

Description.

Minimum: 0

Maximum: 1024

project_id

String

Tenant ID.

Minimum: 32

Maximum: 64

owner_id

String

Owner ID.

Minimum: 32

Maximum: 64

creator_id

String

Creator ID.

Minimum: 32

Maximum: 64

edit_role

String

Edit

Minimum: 32

Maximum: 64

use_role

String

User role.

Minimum: 32

Maximum: 64

approve_role

String

Reviewer.

Minimum: 32

Maximum: 64

enabled

Boolean

Enabled or not

workspace_id

String

Workspace ID

Minimum: 32

Maximum: 64

version_id

String

Workflow version ID.

Minimum: 32

Maximum: 64

current_approval_version_id

String

Version to be viewed currently.

Minimum: 1

Maximum: 64

current_rejected_versoin_id

String

Version that has been rejected currently.

Minimum: 1

Maximum: 64

aop_type

String

AOP types. - NORMAL: General - SURVEY: Investigation - HEMOSTASIS: Prevention - EASE: Mitigation

Minimum: 1

Maximum: 64

engine_type

String

There are two types of engine, shared and dedicated.

Minimum: 1

Maximum: 64

dataclass_id

String

ID of the data class.

Minimum: 1

Maximum: 64

Status code: 400

Table 7 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID, in the format request_uuid-timestamp-hostname.

Table 8 Response body parameters

Parameter

Type

Description

code

String

Error Code

Minimum: 0

Maximum: 64

message

String

Error Description

Minimum: 0

Maximum: 1024

Example Requests

Query the workflow list. The offset is 10, and three alerts are queried.

{
  "limit" : 3,
  "offset" : 10
}

Example Responses

Status code: 200

Request succeeded.

{
  "code" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
  "message" : "Error message",
  "total" : 41,
  "limit" : 2,
  "offset" : 1,
  "success" : true,
  "data" : [ {
    "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "name" : "Workflow name.",
    "description" : "Description.",
    "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "owner_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "creator_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "edit_role" : "Editor.",
    "use_role" : "User.",
    "approve_role" : "Approver.",
    "enabled" : true,
    "workspace_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "version_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "current_approval_version_id" : "v2",
    "current_rejected_versoin_id" : "v1",
    "aop_type" : "Mitigation (ease).",
    "engine_type" : "public_engine",
    "dataclass_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f"
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

Query the workflow list. The offset is 10, and three alerts are queried.

 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
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.secmaster.v2.region.SecMasterRegion;
import com.huaweicloud.sdk.secmaster.v2.*;
import com.huaweicloud.sdk.secmaster.v2.model.*;


public class ListWorkflowsSolution {

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

        SecMasterClient client = SecMasterClient.newBuilder()
                .withCredential(auth)
                .withRegion(SecMasterRegion.valueOf("<YOUR REGION>"))
                .build();
        ListWorkflowsRequest request = new ListWorkflowsRequest();
        request.withEnabled(<enabled>);
        request.withLastVersion(<last_version>);
        request.withName("<name>");
        request.withDescription("<description>");
        request.withDataclassId("<dataclass_id>");
        request.withDataclassName("<dataclass_name>");
        request.withAopType("<aop_type>");
        request.withOffset(<offset>);
        request.withLimit(<limit>);
        request.withOrder(ListWorkflowsRequest.OrderEnum.fromValue("<order>"));
        request.withSortby(ListWorkflowsRequest.SortbyEnum.fromValue("<sortby>"));
        try {
            ListWorkflowsResponse response = client.listWorkflows(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());
        }
    }
}

Query the workflow list. The offset is 10, and three alerts are queried.

 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
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdksecmaster.v2.region.secmaster_region import SecMasterRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksecmaster.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 = SecMasterClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListWorkflowsRequest()
        request.enabled = <Enabled>
        request.last_version = <LastVersion>
        request.name = "<name>"
        request.description = "<description>"
        request.dataclass_id = "<dataclass_id>"
        request.dataclass_name = "<dataclass_name>"
        request.aop_type = "<aop_type>"
        request.offset = <offset>
        request.limit = <limit>
        request.order = "<order>"
        request.sortby = "<sortby>"
        response = client.list_workflows(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Query the workflow list. The offset is 10, and three alerts are queried.

 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"
    secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/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 := secmaster.NewSecMasterClient(
        secmaster.SecMasterClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListWorkflowsRequest{}
	enabledRequest:= <enabled>
	request.Enabled = &enabledRequest
	lastVersionRequest:= <last_version>
	request.LastVersion = &lastVersionRequest
	nameRequest:= "<name>"
	request.Name = &nameRequest
	descriptionRequest:= "<description>"
	request.Description = &descriptionRequest
	dataclassIdRequest:= "<dataclass_id>"
	request.DataclassId = &dataclassIdRequest
	dataclassNameRequest:= "<dataclass_name>"
	request.DataclassName = &dataclassNameRequest
	aopTypeRequest:= "<aop_type>"
	request.AopType = &aopTypeRequest
	offsetRequest:= float32(<offset>)
	request.Offset = &offsetRequest
	limitRequest:= float32(<limit>)
	request.Limit = &limitRequest
	orderRequest:= model.GetListWorkflowsRequestOrderEnum().<ORDER>
	request.Order = &orderRequest
	sortbyRequest:= model.GetListWorkflowsRequestSortbyEnum().<SORTBY>
	request.Sortby = &sortbyRequest
	response, err := client.ListWorkflows(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

Request succeeded.

400

Response body of the failed requests for querying the data class list.

Error Codes

See Error Codes.