# 查询Workflow待办事项 - ShowWorkflowsTodolist #### 功能介绍 查询Workflow待办事项接口用于查看所有待处理的工作流任务信息。 该接口适用于以下场景：当用户需要跟踪工作流中的任务进度、查看所有待处理的任务以便安排工作，或者在系统初始化时加载所有待办事项信息时，用户可通过此接口获取待办事项列表。使用该接口的前提条件是用户已登录系统且具有查看待办事项的权限。调用成功后，接口将返回包含所有待办事项详细信息的响应，包括待办事项的时间、工作流ID、工作流执行ID、节点名称、状态等。若用户未登录、权限不足或系统中不存在待办事项，接口将返回相应的错误信息。 #### 接口约束 无 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=ShowWorkflowsTodolist)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-modelarts/modelarts_03_0138.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | modelarts:workflow:list | List | - | - | - | - | #### URI GET /v2/{project_id}/workflows/todolist 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** ：用户项目ID。获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-modelarts/modelarts_03_0147.html)。 **约束限制**：1 - 64字符，字母、数字和中划线。 **取值范围**：不涉及。 **默认取值**：不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | workspace_id | 否 | String | **参数解释** ：工作空间ID。获取方法请参见[查询工作空间列表](https://support.huaweicloud.com/api-modelarts/ListWorkspace.html#ZH-CN_TOPIC_0000002723741766)。 **约束限制**：存在并使用的工作空间。 **取值范围**：不涉及。 **默认取值**："0"。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | items | Array of [WorkflowTodo] objects | **参数解释**：待办列表。 | | total | Integer | **参数解释**：条目个数。 **取值范围**：不涉及。 | 表4WorkflowTodo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | time | String | **参数解释**：时间。 **取值范围**：不涉及。 | | duration | Integer | **参数解释**：运行时长。 **取值范围**：不涉及。 | | workflow_id | String | **参数解释**：Workflow工作流ID。 **取值范围**：不涉及。 | | workflow_name | String | **参数解释**：工作流名称。填写1-64位，仅包含英文、数字、下划线（_）和中划线（-），并且以英文开头的名称。 **取值范围**：不涉及。 | | execution_id | String | **参数解释**：工作流执行ID。 **取值范围**：不涉及。 | | step_name | String | **参数解释**：节点名称。 **取值范围**：不涉及。 | | step_title | String | **参数解释**：节点的Title。 **取值范围**：不涉及。 | | status | String | **参数解释**：状态。 **取值范围**：枚举值如下： - init：初始化 - skipped：跳过 - wait_inputs：等待输入中 - pending：排队中 - creating：创建中 - created：创建成功 - create_failed：创建失败 - running：运行中 - hold：暂停 - stopping：停止中 - stopped：已停止 - timeout：超时 - completed：运行成功 - failed：运行失败 | #### 请求示例 查看Workflow工作流的待办事项。 ``` GET https://{endpoint}/v2/{project_id}/workflows/todolist?workspace_id=0 ``` #### 响应示例 **状态码：200** ``` { "total" : 5, "items" : [ { "time" : "2022-10-28T15:31:43.409368+08:00", "duration" : 366181, "workflow_id" : "bd711470-e00f-422a-8da4-8a7fa06f4b8c", "workflow_name" : "wf-test-service-xiahou", "execution_id" : "837f989e-ff44-4089-90f5-ec6d790d339d", "step_name" : "service_step", "step_title" : "install service", "status" : "wait_inputs" }, { "time" : "2022-10-28T15:31:28.753908+08:00", "duration" : 366196, "workflow_id" : "acf1a43e-3037-4e97-8438-d21fe38d31dd", "workflow_name" : "workflow-service-infer2", "execution_id" : "2d235b72-c9e2-4277-9a10-b826746d38e7", "step_name" : "service_step", "step_title" : "service_step", "status" : "wait_inputs" }, { "time" : "2022-10-27T15:01:33.644611+08:00", "duration" : 454391, "workflow_id" : "79232863-7d4c-4e36-af8a-b4030da7b525", "workflow_name" : "MAssist_checkpoint_url_beta2_4dc3a098-2687-400a-a621-11fe1ff6542", "execution_id" : "2d2affa3-892f-4b2f-87de-a22f8b8d018a", "step_name" : "condition_step", "step_title" : "skip training", "status" : "wait_inputs" }, { "time" : "2022-10-20T15:01:42.650076+08:00", "duration" : 1059182, "workflow_id" : "b94d87ad-ccc3-4d7a-ac3e-a4907ccf8247", "workflow_name" : "MAssist_checkpoint_url2_c508a2ac-e146-42dd-8e5b-249dc4a117ee", "execution_id" : "0f2bb91c-3a60-49bd-a32e-190797d90ebd", "step_name" : "condition_step_test", "step_title" : "condition_step_test", "status" : "wait_inputs" }, { "time" : "2022-10-20T14:53:13.05412+08:00", "duration" : 1059692, "workflow_id" : "e6d01c2e-0ff7-42ea-a0da-363660b730bd", "workflow_name" : "MAssist_checkpoint_url3_2086aa8f-09b7-4dae-b262-642d0d80519e", "execution_id" : "2aa33bf2-7ddb-4401-adb9-627952a282e9", "step_name" : "labeling", "step_title" : "data labeling", "status" : "hold" } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。