# 查询工作流实例列表(Python SDK) #### 功能说明 查询工作流实例列表。 #### 接口约束 - OBS支持的Region与Endpoint的对应关系，详细信息请参见[地区与终端节点](https://developer.huaweicloud.com/endpoint?OBS)。 #### 方法定义 ``` WorkflowClient.listWorkflowExecution(graphName, executionType=None, nextMarker=None, limit=None, executionState=None) ``` #### 请求参数 表1请求参数列表 | **名称** | **是否必选** | **参数类型** | **描述** | |:---|:---|:---|:---| | executionType | 否 | str | **参数解释** **：** 工作流实例的执行方式 **取值范围：** - APICALL: 要查询以API触发的工作流实例 - TRIGGERCAL: 要查询以事件触发的工作流实例列表 **默认取值：** 无 | | nextMarker | 否 | str | **参数解释** **：** 列举列表时，指定一个标识符，返回的工作流实例列表将是按照字典顺序排序后这个标识符以后的所有工作流实例。 **约束限制：** 该标识由两部分组成：触发类型+工作流实例名 其中触发类型枚举值见"executionType"字段的约束。 **默认取值：** 无 | | limit | 否 | int | **参数解释** **：** 请求返回的最大记录条数 **取值范围：** \[1，1000\] **默认取值：** 10 | | graphName | 是 | str | **参数解释** **：** 工作流名称 **约束限制：** 是已存在的工作流 **默认取值：** 无 | | executionState | 否 | str | **参数解释** **：** 工作流实例当前状态 **取值范围：** - RUNNING，执行中 - SUCCESS，执行成功 - FAILED，执行失败 **默认取值：** 无 | #### 返回结果 表2返回结果 | **类型** | **说明** | |:---|:---| | [GetResult] | **参数解释：** SDK公共结果对象。 | 表3GetResult | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | status | int | **参数解释：** HTTP状态码。 **取值范围：** 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 **默认取值：** 无 | | reason | str | **参数解释：** HTTP文本描述。 **默认取值：** 无 | | errorCode | str | **参数解释：** OBS服务端错误码，当status参数小于300时为空。 **默认取值：** 无 | | errorMessage | str | **参数解释：** OBS服务端错误描述，当status参数小于300时为空。 **默认取值：** 无 | | requestId | str | **参数解释：** OBS服务端返回的请求ID。 **默认取值：** 无 | | indicator | str | **参数解释：** OBS服务端返回的错误定位码。 **默认取值：** 无 | | hostId | str | **参数解释：** 请求的服务端ID，当status参数小于300时为空。 **默认取值：** 无 | | resource | str | **参数解释：** 发生错误时相关的桶或对象，当status参数小于300时为空。 **默认取值：** 无 | | header | list | **参数解释：** 响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。 **默认取值：** 无 | | body | object | **参数解释：** 操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见"桶相关接口"章节和"对象相关接口"章节的详细描述。 **默认取值：** 无 | 表4返回结果 | **GetResult.body类型** | 说明 | |:---|:---| | [表5] | **参数解释：** 响应结果，详见[表5] | 表5ListWorkflowExecutionResponse | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | count | int | **参数解释** **：** 满足条件的运行实例个数 **取值范围：** 大于等于0的整型数。 **默认取值：** 无 | | nextMarker | str | **参数解释** **：** 用于标明本次请求列举到的最后一个工作流实例。后续请求可以指定nextMarker等于该值来列举剩余的工作流实例。 **约束限制：** 如果isTruncated为false，该字段不会返回。 **默认取值：** 无 | | isTruncated | bool | **参数解释** **：** 表明是否本次返回的ListWorkflowExecution结果列表被截断。 **取值范围**： True：本次没有返回全部结果 False：本次已经返回了全部结果 **默认取值：** 无 | | executions | Array ExecutionDetail Json结构体 [结构体说明](https://support.huaweicloud.com/sdk-python-devg-obs/obs_22_1121.html) | **参数解释** **：** 实例信息列表 **默认取值：** 无 | #### 代码样例 ``` # 引入模块 import os from obs import WorkflowClient # 创建WorkflowClient实例 workflow_client = WorkflowClient( access_key_id = os.getenv("AccessKeyID"), secret_access_key = os.getenv("SecretAccessKey"), server = 'https://your-endpoint' ) # 查询工作流实例列表 try: resp = workflow_client.listWorkflowExecution('graphName', executionType='executionType', nextMarker='nextMarker', limit='limit', executionState='executionState') if resp.status < 300: print('requestId:', resp.requestId) else: print('errorCode:', resp.errorCode) print('errorMessage:', resp.errorMessage) except Exception: import traceback print(traceback.format_exc()) # 关闭workflowClient workflow_client.close() ``` #### 相关链接 - 关于查询工作流实例列表的API说明，请参见[查询工作流实例列表](https://support.huaweicloud.com/api-dwr/dwr_04_0128.html)。 - 查询工作流实例列表过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。