# 获取Execution列表 - ListWorkflowExecutions #### 功能介绍 查询Workflow下的执行记录列表。 获取Execution列表接口用于查询指定工作流的执行实例列表。该接口适用于以下场景：当用户需要监控工作流执行状态、排查执行异常或管理执行历史时，可通过此接口获取指定工作流的所有执行实例信息。使用该接口的前提条件是用户已登录系统并具备查看工作流的权限，且目标工作流已存在。查询操作完成后，接口将返回所有符合条件的执行实例列表，包括每个实例的ID、状态、开始时间、结束时间及执行结果等详细信息。若用户无权限访问目标工作流或工作流不存在，接口将返回相应的错误信息。 #### 接口约束 无 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=ListWorkflowExecutions)中调试该接口，支持自动认证鉴权。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/{workflow_id}/executions 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** ：用户项目ID。获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-modelarts/modelarts_03_0147.html)。 **约束限制**：1 - 64字符，字母、数字和中划线。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | workflow_id | 是 | String | **参数解释**：工作流的ID。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | workspace_id | 否 | String | **参数解释** ：工作空间ID。获取方法请参见[查询工作空间列表](https://support.huaweicloud.com/api-modelarts/ListWorkspace.html#ZH-CN_TOPIC_0000002741393737)。 **约束限制**：存在并使用的工作空间。 **取值范围**：不涉及。 **默认取值**："0"。 | | limit | 否 | String | **参数解释**：分页参数limit，表示单次查询的条目数上限。假如要查询20\~29条记录，offset为20，limit为10。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | sort_by | 否 | String | **参数解释**：排序依据字段，例如sort_by=create_time，则表示以条目的创建时间进行排序。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | offset | 否 | String | **参数解释**：分页参数offset，表示单次查询的条目偏移数量。假如要查询20\~29条记录，offset为20，limit为10。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | labels | 否 | String | **参数解释**：执行记录标签。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | status | 否 | String | **参数解释**：执行记录状态。 **约束限制**：不涉及。 **取值范围**：枚举值如下： - init：初始化 - running：运行中 - wait_inputs：等待输入中 - hold：暂停 - completed：运行成功 - failed：运行失败 - stopping：停止中 - stopped：已停止 - timeout：超时 **默认取值**：不涉及。 | | scene_id | 否 | String | **参数解释**：场景ID。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | order | 否 | String | **参数解释**：排序的方式。 **约束限制**：该字段必须与sort_by同时使用。 **取值范围**：枚举值： - asc：升序排列。 - desc：降序排列。 **默认取值**：desc。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | **参数解释**：总数。 **取值范围**：不涉及。 | | count | Integer | **参数解释**：返回个数。 **取值范围**：不涉及。 | | items | Array of [WorkflowExecutionResp] objects | **参数解释**：execution数组。 | 表4WorkflowExecutionResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | created_at | String | **参数解释**：创建时间。 **取值范围**：不涉及。 | | name | String | **参数解释**：执行记录名称。 **取值范围**：不涉及。 | | execution_id | String | **参数解释** ：工作流执行ID。获取方法请参见[获取Execution列表](https://support.huaweicloud.com/api-modelarts/ListWorkflowExecutions.html#ZH-CN_TOPIC_0000002741353711)。。 **取值范围**：不涉及。 | | description | String | **参数解释**：执行记录描述。 **取值范围**：不涉及。 | | status | String | **参数解释**：执行记录状态。 **取值范围**：枚举值如下： - init：初始化 - running：运行中 - completed：运行成功 - stopped：已停止 - abnormal：异常 | | workspace_id | String | **参数解释** ：工作空间ID。获取方法请参见[查询工作空间列表](https://support.huaweicloud.com/api-modelarts/ListWorkspace.html#ZH-CN_TOPIC_0000002741393737)。 **取值范围**：不涉及。 | | workflow_id | String | **参数解释**：Workflow工作流ID。 **取值范围**：不涉及。 | | workflow_name | String | **参数解释**：工作流名称。 **取值范围**：不涉及。 | | scene_id | String | **参数解释** ：自定义场景ID，获取方法请参见[查询工作流执行记录列表](https://support.huaweicloud.com/api-modelarts/CreateWorkflow.html#ZH-CN_TOPIC_0000002741353707)。 **取值范围**：不涉及。 | | scene_name | String | **参数解释**：自定义场景名称。 **取值范围**：不涉及。 | | steps_execution | Array of [StepExecutionResp] objects | **参数解释**：执行记录的step。 | | sub_graphs | Array of [WorkflowSubgraphResp] objects | **参数解释**：子图。 | | duration | String | **参数解释**：执行的时长。 **取值范围**：不涉及。 | | events | Array of strings | **参数解释**：执行的事件。 | | labels | Array of strings | **参数解释**：为执行记录设置的标签。 | | data_requirements | Array of [DataRequirementResp] objects | **参数解释**：节点steps使用到的数据。 | | parameters | Array of [WorkflowParameterResp] objects | **参数解释**：节点steps使用到的参数。 | | policies | [WorkflowDagPoliciesResp] object | **参数解释**：执行记录使用到的执行策略。 | 表5StepExecutionResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | step_name | String | **参数解释**：节点的名称，在一个DAG中唯一。 **取值范围**：不涉及。 | | execution_name | String | **参数解释**：执行记录的名称。 **取值范围**：不涉及。 | | name | String | **参数解释**：执行记录与节点的组合名称。 **取值范围**：不涉及。 | | uuid | String | **参数解释**：唯一标识uuid。创建节点执行时，后台自动生成。 **取值范围**：不涉及。 | | execution_uuid | String | **参数解释**：执行记录的UUID。 **取值范围**：不涉及。 | | created_at | String | **参数解释**：Execution执行的创建时间。 **取值范围**：不涉及。 | | updated_at | String | **参数解释**：Execution执行的更新时间。 **取值范围**：不涉及。 | | duration | Integer | **参数解释**：Execution执行的运行时长。 **取值范围**：不涉及。 | | type | String | **参数解释**：节点的类型。 **取值范围**：枚举值如下: - job：训练 - labeling：标注 - release_dataset：数据集发布 - model：模型发布 - service：服务部署 - mrs_job：MRS作业 - dataset_import：数据集导入 - create_dataset：创建数据集 | | instance_id | String | **参数解释**：实例ID。 **取值范围**：不涉及。 | | status | String | **参数解释**：节点的状态。 **取值范围**：枚举值如下： - init：初始化 - wait_inputs：等待输入 - pending：等待 - creating：创建中 - created：创建成功 - create_failed：创建失败 - running：运行中 - stopping：停止中 - stopped：停止 - timeout：超时 - completed：完成 - failed：失败 - hold：暂停 - skipped：跳过 | | inputs | Array of [JobInputResp] objects | **参数解释**：节点的输入项。 | | outputs | Array of [JobOutputResp] objects | **参数解释**：节点的输出项。 | | step_uuid | String | **参数解释**：节点的UUID，唯一性标识。 **取值范围**：不涉及。 | | properties | Map\ | **参数解释**：节点的属性。 | | events | Array of strings | **参数解释**：节点发生的事件。 | | error_info | [WorkflowErrorInfoResp] object | **参数解释**：Execution执行的错误信息。 | | policy | [WorkflowStepExecutionPolicyResp] object | **参数解释**：节点的执行策略。 | | conditions_execution | [WorkflowConditionExecutionResp] object | **参数解释**：条件执行。 | | step_title | String | **参数解释**：节点标题。 **取值范围**：不涉及。 | | conditions | Array of [StepConditionResp] objects | **参数解释**：条件节点执行条件。 | 表6JobInputResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**：输入数据的名称。 **取值范围**：不涉及。 | | type | String | **参数解释**：输入项类型。 **取值范围**：枚举值如下： - dataset：数据集 - obs：OBS - data_selector：数据选择 | | data | Object | **参数解释**：输入项数据。 | | value | Object | **参数解释**：输入项的值。 | 表7JobOutputResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**：输出数据的名称。 **取值范围**：不涉及。 | | type | String | **参数解释**：输出项类型。 **取值范围**：枚举值如下： - obs：OBS - model：AI应用元模型 | | config | Map\ | **参数解释**：输出配置。 | 表8WorkflowErrorInfoResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：错误码。 **取值范围**：不涉及。 | | error_message | String | **参数解释**：错误信息。 **取值范围**：不涉及。 | 表9WorkflowStepExecutionPolicyResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | execution_policy | String | **参数解释**：执行策略， **取值范围**：可选值如下： - retry：重试 - stop：停止 - continue：继续运行 | | use_cache | Boolean | **参数解释**：是否使用的是缓存。 **取值范围**： - true：是缓存 - false：不是缓存 | 表10WorkflowConditionExecutionResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | result | String | **参数解释**：执行结果。 **取值范围**：不涉及。 | | metric_list | Array of [WorkflowMetricPairResp] objects | **参数解释**：工作流度量信息列表。 | 表11WorkflowMetricPairResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**：度量信息metric的key。 **取值范围**：不涉及。 | | value | Object | **参数解释**：度量信息metric的值。 | 表12StepConditionResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数解释**：判断类型，例如==（等于）、!=（不等于）、\>（大于）、\>=（大于等于）、\<（小于）、\<=（小于等于）、in（包含）、or（或）。 **取值范围**：不涉及。 | | left | Object | **参数解释**：节点执行条件为true时的分支。 | | right | Object | **参数解释**：节点执行条件为false时的分支。 | 表13WorkflowSubgraphResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**：子图名称。 **取值范围**：不涉及。 | | steps | Array of strings | **参数解释**：子图step成员。 | 表14DataRequirementResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**：训练数据的名称。 **取值范围**：不涉及。 | | type | String | **参数解释**：数据来源类型。 **取值范围**：枚举值如下： - dataset：数据集 - obs：OBS - swr：SWR - model_list：AI应用列表 - label_task：标注任务 - service：在线服务 | | conditions | Array of [ConstraintResp] objects | **参数解释**：数据约束条件。 | | value | Map\ | **参数解释**：数据的值。 | | used_steps | Array of strings | **参数解释**：使用了这条数据的工作流节点。 | | delay | Boolean | **参数解释**：延时参数标记。 **取值范围**： - true：延时 - false：不延时 | 表15ConstraintResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | attribute | String | **参数解释**：条件属性，参数的某个字段值。 **取值范围**：不涉及。 | | operator | String | **参数解释**：操作。 **取值范围**：不涉及。 | | value | Object | **参数解释**：取值。 | 表16WorkflowParameterResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**：Workflow工作流配置参数的名称。 **取值范围**：不涉及。 | | type | String | **参数解释**：参数的类型。 **取值范围**：枚举值如下: - str：字符串 - int：整型 - bool：布尔类型 - float：浮点型 | | description | String | **参数解释**：Workflow工作流配置参数的描述。 **取值范围**：不涉及。 | | example | Object | **参数解释**：Workflow工作流配置参数的样例。 | | delay | Boolean | **参数解释**：是否为延迟输入的参数。 **取值范围**： - true：是 - false：否 | | default | Object | **参数解释**：配置参数的默认值。 | | value | Object | **参数解释**：参数值。 | | enum | Array of objects | **参数解释**：Workflow工作流配置参数的枚举项。 | | used_steps | Array of strings | **参数解释**：使用这个参数的工作流节点。 | | format | String | **参数解释**：数据格式。 **取值范围**：不涉及。 | | constraint | Map\ | **参数解释**：限制条件。 | 表17WorkflowDagPoliciesResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | use_cache | Boolean | **参数解释**：是否使用缓存。 **取值范围**： - true：使用缓存 - false：不使用缓存 | #### 请求示例 查询工作流执行记录列表 ``` GET https://{endpoint}/v2/{project_id}/workflows/{workflow_id}/executions?limit=10&offset=0&sort_by=create_time&order=desc&status=completed ``` #### 响应示例 **状态码：200** OK ``` { "total" : 1, "count" : 1, "items" : [ { "created_at" : "2022-06-17T17:08:16.91019+08:00", "name" : "execution-064", "execution_id" : "918cd9bd-62dd-4179-b5f0-773dd7184a56", "description" : "", "status" : "completed", "workspace_id" : "0", "workflow_id" : "f1642618-43eb-4ab1-a0b1-9cc584182c60", "workflow_name" : "workflow_model_service_no_modify_xiahou_copy", "steps_execution" : [ { "created_at" : "2022-06-17T17:08:16.920281+08:00", "uuid" : "d6148a4a-4a5e-47a3-bc90-3183905b4941", "instance_id" : "{\"model_id\":\"253aba02-4bd6-4f64-8d37-66022ae7af4d\"}", "step_name" : "model_step", "step_title" : "model release", "status" : "completed", "duration" : 16, "inputs" : [ { "name" : "model_input", "type" : "obs", "data" : "$ref/data_requirements/model_input", "value" : { "object_type" : [ "DIRECTORY" ], "obs_url" : "/test-crq/train_output/" } } ], "outputs" : [ { "name" : "model_output", "type" : "model", "config" : { "model_id" : "253aba02-4bd6-4f64-8d37-66022ae7af4d" } } ], "properties" : { "model_name" : "lh-xh", "model_type" : "TensorFlow" }, "events" : [ "2022-06-17 17:08:17 change status from init to creating", "2022-06-17 17:08:19 change status from creating to created", "2022-06-17 17:08:20 change status from created to running", "2022-06-17 17:08:33 change status from running to completed" ], "policy" : { } }, { "created_at" : "2022-06-17T17:08:33.038184+08:00", "uuid" : "b34b2b54-eb70-4c7f-a92d-05f849d8c39a", "instance_id" : { "type" : "deploy", "service_id" : "81f22d60-5488-4e3d-bba9-08c812ae84b0", "status" : "", "update_time" : 0 }, "step_name" : "service_step", "step_title" : "service install", "status" : "completed", "duration" : 83430, "inputs" : [ { "name" : "service_input", "type" : "model_list", "data" : "$ref/data_requirements/service_model", "value" : { "model_list" : [ { "envs" : { }, "instance_count" : 1, "model_id" : "253aba02-4bd6-4f64-8d37-66022ae7af4d", "model_name" : "lh-xh", "model_version" : "0.0.62", "specification" : "modelarts.vm.ai1", "weight" : 100 } ] } } ], "outputs" : [ { "name" : "service_output", "type" : "service", "config" : { "service_id" : "81f22d60-5488-4e3d-bba9-08c812ae84b0" } } ], "properties" : { "infer_type" : "real-time", "schedule" : -1 }, "events" : [ "2022-06-17 17:08:34 change status from init to wait_inputs", "2022-06-18 16:16:58 change status from wait_inputs to creating", "2022-06-18 16:17:01 change status from creating to created", "2022-06-18 16:17:02 change status from created to running", "2022-06-18 16:19:03 change status from running to completed" ], "policy" : { } } ], "duration" : 11852428, "events" : [ "2022-06-17 17:08:17 step model_step change status from init to creating", "2022-06-17 17:08:19 step model_step change status from creating to created", "2022-06-17 17:08:20 step model_step change status from created to running", "2022-06-17 17:08:33 step model_step change status from running to completed", "2022-06-17 17:08:34 step service_step change status from init to wait_inputs", "2022-06-18 16:16:58 step service_step change status from wait_inputs to creating", "2022-06-18 16:17:01 step service_step change status from creating to created", "2022-06-18 16:17:02 step service_step change status from created to running", "2022-06-18 16:19:03 step service_step change status from running to completed" ], "data_requirements" : [ { "name" : "model_input", "type" : "obs", "conditions" : [ { "attribute" : "object_type", "operator" : "equal", "value" : "directory" } ], "value" : { "object_type" : [ "DIRECTORY" ], "obs_url" : "/test-crq/train_output/" }, "used_steps" : [ "model_step" ] }, { "name" : "service_model", "type" : "model_list", "delay" : true, "conditions" : [ { "attribute" : "model_name", "operator" : "equal", "value" : "lh-xh" } ], "value" : { "model_list" : [ { "envs" : { }, "instance_count" : 1, "model_id" : "253aba02-4bd6-4f64-8d37-66022ae7af4d", "model_name" : "lh-xh", "model_version" : "0.0.62", "specification" : "modelarts.vm.ai1", "weight" : 100 } ] }, "used_steps" : [ "service_step" ] } ], "parameters" : [ { "name" : "schedule_d5sm", "type" : "int", "format" : "schedule", "description" : "Set how long the deployed service will stop in hours, where -1 means the service will always run", "delay" : true, "value" : -1, "used_steps" : [ "service_step" ] } ], "policies" : { } } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。