# 获取StepExecution列表 - ListWorkflowStepExecution #### 功能介绍 获取StepExecution列表接口用于查询指定工作流中各步骤的执行情况。 该接口适用于以下场景：当用户需要监控工作流中各步骤的执行状态、执行时间或执行结果时，可以通过此接口获取详细的StepExecution列表。使用该接口的前提条件是用户已登录且具有查看工作流执行记录的权限。接口响应消息体中包含每个步骤的详细执行信息，如步骤ID、状态、开始时间、结束时间等。若用户无权限操作或指定的工作流不存在，接口将返回相应的错误信息。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=ListWorkflowStepExecution)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-modelarts/modelarts_03_0138.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v2/{project_id}/workflows/{workflow_id}/step-executions 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** ：用户项目ID。获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-modelarts/modelarts_03_0147.html)。 **约束限制**：1 - 64字符，字母、数字和中划线。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | workflow_id | 是 | String | **参数解释**：工作流的ID。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | **参数解释**：返回的数据条目数。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | offset | 否 | Integer | **参数解释**：数据条目偏移量。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | order | 否 | String | **参数解释**：instance order。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | sort_by | 否 | String | **参数解释**：指定排序字段。 **取值范围**：可选值： - user_name：IAM用户名称 - create_time：创建时间 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | **参数解释**：总数。 **取值范围**：不涉及。 | | count | Integer | **参数解释**：返回个数。 **取值范围**：不涉及。 | | items | Array of [StepExecutionResp] objects | **参数解释**：StepExecution数组。 | | default_order | String | **参数解释**：默认排序。 **取值范围**：不涉及。 | | compare_columns | [CompareColumns] object | **参数解释**：度量及参数字段。 | 表4StepExecutionResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | **参数解释**：条件节点执行条件。 | 表5JobInputResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**：输入数据的名称。 **取值范围**：不涉及。 | | type | String | **参数解释**：输入项类型。 **取值范围**：枚举值如下： - dataset：数据集 - obs：OBS - data_selector：数据选择 | | data | Object | **参数解释**：输入项数据。 | | value | Object | **参数解释**：输入项的值。 | 表6JobOutputResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**：输出数据的名称。 **取值范围**：不涉及。 | | type | String | **参数解释**：输出项类型。 **取值范围**：枚举值如下： - obs：OBS - model：AI应用元模型 | | config | Map\ | **参数解释**：输出配置。 | 表7WorkflowErrorInfoResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：错误码。 **取值范围**：不涉及。 | | error_message | String | **参数解释**：错误信息。 **取值范围**：不涉及。 | 表8WorkflowStepExecutionPolicyResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | execution_policy | String | **参数解释**：执行策略， **取值范围**：可选值如下： - retry：重试 - stop：停止 - continue：继续运行 | | use_cache | Boolean | **参数解释**：是否使用的是缓存。 **取值范围**： - true：是缓存 - false：不是缓存 | 表9WorkflowConditionExecutionResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | result | String | **参数解释**：执行结果。 **取值范围**：不涉及。 | | metric_list | Array of [WorkflowMetricPairResp] objects | **参数解释**：工作流度量信息列表。 | 表10WorkflowMetricPairResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**：度量信息metric的key。 **取值范围**：不涉及。 | | value | Object | **参数解释**：度量信息metric的值。 | 表11StepConditionResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数解释**：判断类型，例如==（等于）、!=（不等于）、\>（大于）、\>=（大于等于）、\<（小于）、\<=（小于等于）、in（包含）、or（或）。 **取值范围**：不涉及。 | | left | Object | **参数解释**：节点执行条件为true时的分支。 | | right | Object | **参数解释**：节点执行条件为false时的分支。 | 表12CompareColumns | 参数 | 参数类型 | 描述 | |:---|:---|:---| | parameters | Array of strings | **参数解释**：参数字段。 | | metrics | Array of strings | **参数解释**：度量字段。 | #### 请求示例 ``` GET https://{endpoint}/v2/{project_id}/workflows/{workflow_id}/step-executions?limit=10&offset=0&sort_by=create_time&order=desc ``` #### 响应示例 **状态码：200** ``` { "total" : 1, "count" : 1, "items" : [ { "created_at" : "2022-04-22T10:29:50.313039+08:00", "updated_at" : "2022-04-22T10:32:58.485862+08:00", "uuid" : "af6f746f-41c7-43e9-aecc-fced74f2062a", "name" : "execution-001-training_job", "instance_id" : "{\"job_id\":\"0fd1b230-f737-4ffc-a778-d252a889846b\"}", "step_name" : "training_job", "step_title" : "job_swr", "status" : "completed", "duration" : 188, "execution_name" : "execution-001", "execution_uuid" : "f3007ba2-b70d-4dc9-9282-b9c17919c32d", "properties" : { "algorithm" : { "code_dir" : "/automation-use-only/Original/TrainJob/TrainJob-v2/tensorflow2.1_cuda_10.1/06-CIFAR-VGG/", "command" : "/home/ma-user/anaconda3/envs/TensorFlow-2.1/bin/python /home/ma-user/modelarts/user-job-dir/06-CIFAR-VGG/main1.py", "engine" : { "image_url" : "ei_modelarts_y00218826_05/tensorflow_2_1:train-tensorflow_2.1.0-cuda_10.1-py_3.7-ubuntu_18.04-x86_64-roma-20211104202338-f258e59" } }, "kind" : "job", "metadata" : { "name" : "workflow-bfd177f267754f0486148acd684b8363", "workspace_id" : "0" }, "spec" : { "resource" : { "flavor_id" : "modelarts.vm.cpu.8u", "node_count" : 1, "policy" : "regular" } } }, "events" : [ "2022-04-22 10:29:51 change status from init to creating", "2022-04-22 10:29:52 change status from creating to created", "2022-04-22 10:29:53 change status from created to running", "2022-04-22 10:32:58 change status from running to completed" ], "policy" : { } } ], "default_order" : "asc", "compare_columns" : { } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。