# 查询工作流列表(Python SDK)
#### 功能说明
查询工作流列表。
#### 接口约束
- OBS支持的Region与Endpoint的对应关系，详细信息请参见[地区与终端节点](https://developer.huaweicloud.com/endpoint?OBS)。
 
#### 方法定义
```
WorkflowClient.listWorkflow(graphNamePrefix=None, start=None, limit=None)
```
#### 请求参数
表1请求参数列表 
| **名称**          | **是否必选** | **参数类型** | **描述**                                                                                                                                                                                                                                                                                                                                 |
|:---|:---|:---|:---|
| graphNamePrefix | 否        | str      | **参数解释** **：** 工作流的名称前缀 **约束限制：** 前缀必须以字母或数字开头，只能由字母、数字、下划线和中划线组成，长度小于等于64个字符。 **默认取值：** 无 |
| start           | 否        | int      | **参数解释** **：** 查询的起始位置 **取值范围：** \[1，1000\] **默认取值：** 1                                                                                                                          |
| limit           | 否        | int      | **参数解释** **：** 请求返回的最大记录条数 **取值范围：** \[1，1000\] **默认取值：** 10                                                                                                                      |
   
#### 返回结果
表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] |
   
 表5ListWorkflowResponse 
| **参数名称**    | **参数类型**                                                                                              | **描述**                                                                                                                                                                                                                                                                                                                                                    |
|:---|:---|:---|
| count       | int                                                                                                   | **参数解释** **：** 列表条数 **默认取值：** 无                                                                                                                                                                       |
| graphs      | Array GraphItem Json结构体 [结构体说明](https://support.huaweicloud.com/sdk-python-devg-obs/obs_22_1121.html) | **参数解释** **：** 工作流模板列表信息列表 **默认取值：** 无                                                                                                                                                                |
| nextStart   | int                                                                                                   | **参数解释** **：** 下一次查询的起始位置 **默认取值：** 无                                                                                                                                                                      |
| isTruncated | bool                                                                                                  | **参数解释** **：** 表明是否本次返回的ListWorkflow结果列表被截断。 **取值范围**： True：本次没有返回全部结果 False：本次已经返回了全部结果 **默认取值：** 无 |
   
#### 代码样例
```
# 引入模块
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.listWorkflow(graphNamePrefix='graphNamePrefix', start='start', limit='limit')
    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_0126.html)。
- 查询工作流列表过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。