# 获取训练作业流程阶段信息列表 - ListTrainingJobStages #### 功能介绍 获取训练作业流程阶段信息列表接口用于获取ModelArts平台上指定训练作业的流程阶段信息列表。 该接口适用于以下场景：当用户需要查看特定训练作业的流程阶段记录时，可以通过此接口获取阶段信息列表。使用该接口的前提条件是用户已知训练作业ID，并具有查看阶段信息列表的权限。查询操作完成后，平台将返回包含训练作业的阶段信息记录。若训练作业ID不存在或用户无权限操作，接口将返回相应的错误信息。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=ListTrainingJobStages)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-modelarts/modelarts_03_0138.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | modelarts:trainJob:listStages | List | trainJob \* | - | modelarts:trainJob:get | - | #### URI GET /v2/{project_id}/training-jobs/{training_job_id}/stages 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** ：用户项目ID。获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-modelarts/modelarts_03_0147.html)。 **约束限制**：1 - 64字符，字母、数字和中划线。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | training_job_id | 是 | String | **参数解释** ：训练作业ID。获取方法请参见[查询训练作业列表](https://support.huaweicloud.com/api-modelarts/ListTrainingJobs.html#ZH-CN_TOPIC_0000002723741806)。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_count | Integer | **参数解释**：总条数。 **取值范围**：不涉及。 | | running_records | Array of [StageRecord] objects | **参数解释**：阶段记录。 | 表3StageRecord | 参数 | 参数类型 | 描述 | |:---|:---|:---| | record_order | Integer | **参数解释**：阶段记录序号，顺序递增，最大序号记录为当前最新记录。 **取值范围**：不涉及。 | | stages | Array of [StageInfoWithSub] objects | **参数解释**：主阶段信息列表。 | 表4StageInfoWithSub | 参数 | 参数类型 | 描述 | |:---|:---|:---| | job_id | String | **参数解释**：作业ID。 **取值范围**：不涉及。 | | name | String | **参数解释**：主阶段名称。 **取值范围**： - scheduling：作业调度 - preparing：环境准备 - running：作业运行 - end：作业结束 | | en_message | String | **参数解释**：主阶段英文描述信息。 **取值范围**：不涉及。 | | zh_message | String | **参数解释**：主阶段中文描述信息。 **取值范围**：不涉及。 | | start_time | String | **参数解释**：主阶段开始时间。 **取值范围**：不涉及。 | | end_time | String | **参数解释**：主阶段结束时间。 **取值范围**：不涉及。 | | stage_order | Integer | **参数解释**：主阶段序号。 **取值范围**：\[1,4\]。 | | sub_stages | Array of [SubStage] objects | **参数解释**：子阶段信息列表。 | 表5SubStage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**：子阶段名称。 **取值范围**：不涉及。 | | en_message | String | **参数解释**：子阶段英文描述信息。 **取值范围**：不涉及。 | | zh_message | String | **参数解释**：子阶段中文描述信息。 **取值范围**：不涉及。 | | create_time | String | **参数解释**：子阶段开始时间。 **取值范围**：不涉及。 | #### 请求示例 ``` GET https://{endpoint}/v2/{project_id}/training-jobs/{training_job_id}/stages ``` #### 响应示例 **状态码：200** ``` { "total_count" : 1, "running_records" : [ { "record_order" : 1, "stages" : [ { "job_id" : "a3d68d17-4185-4057-913c-65052cf15262", "name" : "scheduling", "en_message" : "Job Scheduling", "zh_message" : "作业调度", "start_time" : "2025-07-05T16:10:06+08:00", "end_time" : "2025-07-05T16:10:11+08:00", "stage_order" : 1, "sub_stages" : [ { "name" : "JobSchedulingCreated", "en_message" : "Job created", "zh_message" : "作业创建成功", "create_time" : "2025-07-05T16:10:06+08:00" }, { "name" : "JobSchedulingOSQueuing", "en_message" : "Job resource is Queuing", "zh_message" : "作业资源池调度中", "create_time" : "2025-07-05T16:10:10.596151+08:00" }, { "name" : "JobSchedulingCompleted", "en_message" : "Volcano job scheduled", "zh_message" : "volcano job调度成功", "create_time" : "2025-07-05T16:10:11+08:00" }, { "name" : "JobSchedulingQueuing", "en_message" : "Volcano job created", "zh_message" : "volcano job创建成功", "create_time" : "2025-07-05T16:10:11.717826+08:00" } ] }, { "job_id" : "a3d68d17-4185-4057-913c-65052cf15262", "name" : "preparing", "en_message" : "Environment Preparing", "zh_message" : "环境准备", "start_time" : "2025-07-05T16:10:11+08:00", "end_time" : "2025-07-05T16:10:37.612406+08:00", "stage_order" : 2, "sub_stages" : [ { "name" : "JobPreparingStart", "en_message" : "job environment is starting to prepare", "zh_message" : "作业环境开始准备", "create_time" : "2025-07-05T16:10:11+08:00" }, { "name" : "JobPreparingEnvCheck", "en_message" : "job initializing environment is checking", "zh_message" : "初始化环境预检中", "create_time" : "2025-07-05T16:10:27+08:00" }, { "name" : "JobPreparingCodeDownloading", "en_message" : "code is downloading", "zh_message" : "训练代码下载中", "create_time" : "2025-07-05T16:10:31+08:00" }, { "name" : "JobPreparingCompleted", "en_message" : "job environment completed", "zh_message" : "作业环境准备完成", "create_time" : "2025-07-05T16:10:37.612406+08:00" } ] }, { "job_id" : "a3d68d17-4185-4057-913c-65052cf15262", "name" : "running", "en_message" : "Job Running", "zh_message" : "作业运行", "start_time" : "2025-07-05T16:10:37.612406+08:00", "end_time" : "2025-07-05T16:12:27.317809+08:00", "stage_order" : 3, "sub_stages" : [ { "name" : "JobRunningStart", "en_message" : "job is running", "zh_message" : "作业运行中", "create_time" : "2025-07-05T16:10:37.612406+08:00" }, { "name" : "JobRunningTrainingStart", "en_message" : "training process is starting", "zh_message" : "训练进程开始启动", "create_time" : "2025-07-05T16:10:39+08:00" }, { "name" : "JobRunningCompleted", "en_message" : "training process completed", "zh_message" : "训练进程执行完成", "create_time" : "2025-07-05T16:12:22+08:00" } ] }, { "job_id" : "a3d68d17-4185-4057-913c-65052cf15262", "name" : "end", "en_message" : "Job End", "zh_message" : "作业结束", "start_time" : "2025-07-05T16:12:27.317809+08:00", "end_time" : "2025-07-05T16:12:27.317809+08:00", "stage_order" : 4, "sub_stages" : [ { "name" : "JobEnd", "en_message" : "Job end, status: Completed", "zh_message" : "作业结束，运行状态：Completed", "create_time" : "2025-07-05T16:12:27.317809+08:00" } ] } ] } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | ok | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。