Obtaining the Stage Information List of a Training Job
Function
This API is used to obtain the process stage information list of a training job on ModelArts.
This API applies to the following scenario: When you need to view the process stage records of a specific training job, you can use this API to obtain the stage information list. Before using this API, ensure that you have obtained the training job ID and have the permission to view the stage information list. After the query is complete, the platform returns the stage information record of the training job. If the training job ID does not exist or you do not have the operation permission, the API will return an error message.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.
URI
GET /v2/{project_id}/training-jobs/{training_job_id}/stages
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition: Project ID. For details, see Obtaining a Project ID and Name. Constraints: The value can contain 1 to 64 characters. Letters, digits, and hyphens (-) are allowed. Range: N/A Default Value: N/A |
| training_job_id | Yes | String | Definition: Training job ID. For details, see Obtaining Training Jobs. Constraints: N/A Range: N/A Default Value: N/A |
Request Parameters
None
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| total_count | Integer | Definition: Total number of records. Range: N/A |
| running_records | Array of StageRecord objects | Definition: phase record. |
| Parameter | Type | Description |
|---|---|---|
| record_order | Integer | Definition: Sequence number of a phase record. The sequence number increases in ascending order. The record with the largest sequence number is the latest record. Range: N/A |
| stages | Array of StageInfoWithSub objects | Definition: Main phase information list. |
| Parameter | Type | Description |
|---|---|---|
| job_id | String | Definition: Job ID. Range: N/A |
| name | String | Definition: Name of the main phase. Range: |
| en_message | String | Definition: Description of the main phase in English. Range: N/A |
| zh_message | String | Definition: Description of the main phase in Chinese. Range: N/A |
| start_time | String | Definition: Start time of the main phase. Range: N/A |
| end_time | String | Definition: End time of the main phase. Range: N/A |
| stage_order | Integer | Definition: Sequence number of the main phase. Range: [1, 4] |
| sub_stages | Array of SubStage objects | Definition: Sub-phase information list. |
| Parameter | Type | Description |
|---|---|---|
| name | String | Definition: Sub-phase name. Range: N/A |
| en_message | String | Definition: Description of the sub-phase in English. Range: N/A |
| zh_message | String | Definition: Description of the sub-phase in Chinese. Range: N/A |
| create_time | String | Definition: Start time of the sub-phase. Range: N/A |
Example Requests
GET https://{endpoint}/v2/{project_id}/training-jobs/{training_job_id}/stages Example Responses
Status code: 200
ok
{
"total_count" : 1,
"running_records" : [ {
"record_order" : 1,
"stages" : [ {
"job_id" : "a3d68d17-4185-4057-913c-65052cf15262",
"name" : "scheduling",
"en_message" : "Job Scheduling",
"zh_message" : "Job scheduling",
"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" : "Job created",
"create_time" : "2025-07-05T16:10:06+08:00"
}, {
"name" : "JobSchedulingOSQueuing",
"en_message" : "Job resource is Queuing",
"zh_message" : "Job resource pool being scheduled",
"create_time" : "2025-07-05T16:10:10.596151+08:00"
}, {
"name" : "JobSchedulingCompleted",
"en_message" : "Volcano job scheduled",
"zh_message" : "Volcano job scheduled successfully",
"create_time" : "2025-07-05T16:10:11+08:00"
}, {
"name" : "JobSchedulingQueuing",
"en_message" : "Volcano job created",
"zh_message" : "Volcano job created successfully",
"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" : "Environment preparation",
"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" : "Job environment preparation started",
"create_time" : "2025-07-05T16:10:11+08:00"
}, {
"name" : "JobPreparingEnvCheck",
"en_message" : "job initializing environment is checking",
"zh_message" : "The initialization environment pre-checking",
"create_time" : "2025-07-05T16:10:27+08:00"
}, {
"name" : "JobPreparingCodeDownloading",
"en_message" : "code is downloading",
"zh_message" : "Training code being downloaded",
"create_time" : "2025-07-05T16:10:31+08:00"
}, {
"name" : "JobPreparingCompleted",
"en_message" : "job environment completed",
"zh_message" : "Job environment ready",
"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" : "Job running",
"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" : "Job running",
"create_time" : "2025-07-05T16:10:37.612406+08:00"
}, {
"name" : "JobRunningTrainingStart",
"en_message" : "training process is starting",
"zh_message" : "Training process started",
"create_time" : "2025-07-05T16:10:39+08:00"
}, {
"name" : "JobRunningCompleted",
"en_message" : "training process completed",
"zh_message" : "Training process completed",
"create_time" : "2025-07-05T16:12:22+08:00"
} ]
}, {
"job_id" : "a3d68d17-4185-4057-913c-65052cf15262",
"name" : "end",
"en_message" : "Job End",
"zh_message" : "Job completed",
"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" : "Job completed. The running status is **Completed**.",
"create_time" : "2025-07-05T16:12:27.317809+08:00"
} ]
} ]
} ]
} Status Codes
| Status Code | Description |
|---|---|
| 200 | ok |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot