# 查询流程实例的列表 - ListAopWorkflowInstance #### 功能介绍 查询流程实例的列表 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-secmaster/secmaster_03_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-secmaster/secmaster_03_0023.html)。 #### URI GET /v1/{project_id}/workspaces/{workspace_id}/soc/workflows/instances 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。[获取项目ID](https://support.huaweicloud.com/api-secmaster/secmaster_03_0014.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | workspace_id | 是 | String | **参数解释**: 工作空间ID **取值范围**: 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | Integer | **参数解释：** 偏移量 **约束限制：** 0-1000 **取值范围：** 不涉及 **默认取值：** 0 | | limit | 否 | Integer | **参数解释：** 数据量 **约束限制：** 1-100 **取值范围：** 不涉及 **默认取值：** 10 | | sort_key | 否 | String | **参数解释：** 排序字段， - create_time：创建时间 - update_time：更新时间 **约束限制：** 不涉及 **取值范围：** - create_time - update_time **默认取值：** create_time | | sort_dir | 否 | String | **参数解释：** 排序顺序 - ASC：升序 - DESC：降序 **约束限制：** 不涉及 **取值范围：** - ASC：升序 - DESC：降序 **默认取值：** DESC | | from_date | 否 | String | **参数解释**: 开始时间 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认值**: 不涉及 | | to_date | 否 | String | **参数解释**: 截止时间 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认值**: 不涉及 | | workflow_id | 否 | String | **参数解释**: 流程的ID **约束限制**: 不涉及 **取值范围**: 不涉及 **默认值**: 不涉及 | | id | 否 | String | **参数解释**: 实例的ID **约束限制**: 不涉及 **取值范围**: 不涉及 **默认值**: 不涉及 | | name | 否 | String | **参数解释**: 实例的名字 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认值**: 不涉及 | | dataobject_id | 否 | String | **参数解释**: 触发流程对象的id **约束限制**: 不涉及 **取值范围**: 不涉及 **默认值**: 不涉及 | | dataclass_id | 否 | String | **参数解释**: 数据类的ID **约束限制**: 不涉及 **取值范围**: 不涉及 **默认值**: 不涉及 | | playbook_id | 否 | String | **参数解释**: 剧本ID **约束限制**: 不涉及 **取值范围**: 不涉及 **默认值**: 不涉及 | | defence_id | 否 | String | **参数解释**: 防线ID **约束限制**: 不涉及 **取值范围**: 不涉及 **默认值**: 不涉及 | | status | 否 | String | **参数解释**: 流程实例的状态 - RUNNING 运行中 - FAILED 运行失败 - FINISHED 运行结束 - RETRYING 重试中 - TERMINATING 终止中 - TERMINATED 已终止 **约束限制**: 不涉及 **取值范围**: - RUNNING - FAILED - FINISHED - RETRYING - TERMINATING - TERMINATED **默认值**: 不涉及 | | trigger_type | 否 | String | **参数解释**: 触发方式 - DEBUG 调试触发 - TIMER 定时触发 - EVENT 事件触发 - MANUAL 手动触发 **约束限制**: 不涉及 **取值范围**: - DEBUG - TIMER - EVENT - MANUAL **默认值**: 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。[获取用户Token](https://support.huaweicloud.com/api-secmaster/secmaster_03_0010.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | Content-Type | 是 | String | **参数解释：** 内容类型 - application/json;charset=UTF-8 普通API请求的类型 **约束限制：** 不涉及 **取值范围：** - application/json;charset=UTF-8 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | count | Integer | **参数解释**: 流程实例的个数 **约束限制**: 不涉及 | | instances | Array of [AopworkflowInstanceDetail] objects | **参数解释**: 流程实例详情的列表 **约束限制**: 不涉及 | 表5AopworkflowInstanceDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**: 流程实例的ID **约束限制**: 不涉及 | | name | String | **参数解释**: 流程实例的名字 **约束限制**: 不涉及 | | workflow | [workflow] object | 流程对象 | | dataclass | [dataclass] object | 数据类对象 | | playbook | [playbook] object | 剧本对象 | | trigger_type | String | **参数解释**: 触发方式 **取值范围**: - DEBUG 调试触发 - TIMER 定时触发 - EVENT 事件触发 - MANUAL 手动触发 | | status | String | **参数解释**: 流程实例的状态 **取值范围**: - RUNNING 运行中 - FAILED 运行失败 - FINISHED 运行结束 - RETRYING 重试中 - TERMINATING 终止中 - TERMINATED 已终止 | | start_time | String | **参数解释**: 开始时间 **约束限制**: 不涉及 | | end_time | String | **参数解释**: 结束时间 **约束限制**: 不涉及 | | retry_count | Integer | **参数解释**: 流程实例重试次数 **约束限制**: 不涉及 | | defense_id | String | **参数解释**: 防线ID **约束限制**: 不涉及 | | dataobject_id | String | **参数解释**: dataobject的ID **约束限制**: 不涉及 | | topology | [WorkflowInstanceTopology] object | **参数解释**: 流程实例拓扑图信息 **约束限制**: 不涉及 | 表6workflow | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**: 流程的ID **约束限制**: 不涉及 | | name | String | **参数解释**: 流程的中文名字 **约束限制**: 不涉及 | | name_en | String | **参数解释**: 流程的英文名字 **约束限制**: 不涉及 | | version | String | **参数解释**: 流程的版本 **约束限制**: 不涉及 | | version_id | String | **参数解释**: 流程的版本ID **约束限制**: 不涉及 | 表7dataclass | 参数 | 参数类型 | 描述 | |:---|:---|:---| | en_name | String | **参数解释**: 数据类的英文名字 **约束限制**: 不涉及 | | id | String | **参数解释**: 数据类的ID **约束限制**: 不涉及 | | name | String | **参数解释**: 数据类的中文名字 **约束限制**: 不涉及 | 表8playbook | 参数 | 参数类型 | 描述 | |:---|:---|:---| | en_name | String | **参数解释**: 剧本英文名字 **约束限制**: 不涉及 | | id | String | **参数解释**: 剧本的ID **约束限制**: 不涉及 | | name | String | **参数解释**: 剧本的名字 **约束限制**: 不涉及 | 表9WorkflowInstanceTopology | 参数 | 参数类型 | 描述 | |:---|:---|:---| | audit_logs | Array of [TopologyNodeInfo] objects | **参数解释**: 拓扑图节点信息 **约束限制**: 不涉及 | 表10TopologyNodeInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | instance_type | String | **参数解释**: 流程图拓扑图的节点实例类型 **取值范围**: - TASK | | action_id | String | **参数解释**: 流程拓扑图的节点ID **取值范围**: 不涉及 | | action_name | String | **参数解释**: 流程拓扑图的节点名称 **取值范围**: 不涉及 | | start_time | String | **参数解释**: 流程图拓扑图的节点开始时间 **取值范围**: - 不涉及 | | end_time | String | **参数解释**: 流程图拓扑图的节点结束时间 **取值范围**: - 不涉及 | | error_msg | String | **参数解释**: 流程图拓扑图的节点错误信息 **取值范围**: - 不涉及 | | input | String | **参数解释**: 流程图拓扑图的节点输入信息 **取值范围**: - 不涉及 | | output | String | **参数解释**: 流程图拓扑图的节点输出信息 **取值范围**: - 不涉及 | | parent_instance_id | String | **参数解释**: 流程图拓扑图的父实例ID **取值范围**: - 不涉及 | | status | String | **参数解释**: 流程图拓扑图的节点的状态 **取值范围**: - RUNNING 运行中 - FAILED 运行失败 - FINISHED 运行结束 | | succeed | Boolean | **参数解释**: 流程图拓扑图的节点是否成功 **取值范围**: - true 成功 - false 失败 | **状态码：400** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释**: 错误码 **取值范围**: 不涉及 | | message | String | **参数解释**: 错误描述 **取值范围**: 不涉及 | #### 请求示例 查询名字为ZFGJZDGB-20250718151103的实例列表 ``` https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/soc/workflows/instances?limit=10&offset=0&name=ZFGJZDGB-20250718151103 ``` #### 响应示例 **状态码：200** 查询流程实例列表的响应 ``` { "count" : 1, "instances" : [ { "dataclass" : { "id" : "e410ae50-43fa-343e-807a-a2a9edb8018e", "name" : "Alert" }, "dataobject_id" : "2462e8c3-e393-4af9-93b6-fe424c0b4e39", "defense_id" : "", "end_time" : "2025-07-18T15:11:04.577Z+0800", "id" : "8eed56de-7aaf-4732-baaf-46c1bb11dc8f", "name" : "ZFGJZDGB-20250718151103", "playbook" : { "id" : "3e966553-f53d-3d87-835e-7697e353876a", "name" : "Automatic closing of repeated alerts" }, "retry_count" : 0, "start_time" : "2025-07-18T15:11:03.000Z+0800", "status" : "FINISHED", "trigger_type" : "EVENT", "workflow" : { "id" : "4a6fe02f-b4b4-3b5f-8a11-6f22229e18db", "name" : "Automatic closing of repeated alerts", "version" : "v1", "version_id" : "9f436a38-5c82-312b-aaba-b91a48e99086" } } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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.v1.region.SecMasterRegion; import com.huaweicloud.sdk.secmaster.v1.*; import com.huaweicloud.sdk.secmaster.v1.model.*; public class ListAopWorkflowInstanceSolution { 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); SecMasterClient client = SecMasterClient.newBuilder() .withCredential(auth) .withRegion(SecMasterRegion.valueOf("")) .build(); ListAopWorkflowInstanceRequest request = new ListAopWorkflowInstanceRequest(); request.withWorkspaceId("{workspace_id}"); try { ListAopWorkflowInstanceResponse response = client.listAopWorkflowInstance(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] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdksecmaster.v1.region.secmaster_region import SecMasterRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksecmaster.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 = SecMasterClient.new_builder() \ .with_credentials(credentials) \ .with_region(SecMasterRegion.value_of("")) \ .build() try: request = ListAopWorkflowInstanceRequest() request.workspace_id = "{workspace_id}" response = client.list_aop_workflow_instance(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] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := secmaster.NewSecMasterClient(hcClient) request := &model.ListAopWorkflowInstanceRequest{} request.WorkspaceId = "{workspace_id}" response, err := client.ListAopWorkflowInstance(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/SecMaster/sdk?api=ListAopWorkflowInstance&version=v1)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询流程实例列表的响应 | | 400 | 异常的响应 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-secmaster/ErrorCode.html)。