Updating a Training Job
Function
This API is used to modify the description, event notification, priority, and preemption allowance of an existing training job.
This API is applicable in scenarios where you need to update the description, event notification, priority, or preemption allowance of a training job. Before using this API, ensure that the training job exists and you have the required permissions. After the update, the description, event notification, priority, and preemption allowance of the training job will be updated accordingly. If the training job does not exist or you do not have the required permissions, an error message will be returned.
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, the following identity policy-based permissions are required.
URI
PUT /v2/{project_id}/training-jobs/{training_job_id}
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition: Project ID. For details, see Obtaining a Project ID and Name. Constraints: N/A Range: The value can contain 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed. 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
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| description | No | String | Definition: Training job description. Constraints: The length range is [0, 256]. Range: N/A Default Value: NULL |
| spec | No | spec object | Definition: Training job specifications. Constraints: N/A |
| endpoints | No | JobEndpointsReq object | Definition: Configurations required for remotely accessing a training job. Constraints: N/A |
| metadata | No | metadata object | Definition: Training job metadata. Constraints: N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| notification | No | Notification object | Definition: Message notification of a training event. Constraints: N/A |
| schedule_policy | No | schedule_policy object | Definition: Scheduling policy of a training job. Constraints: N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| topic_urn | No | String | Definition: URN of the selected topic in SMN. Constraints: N/A Range: N/A Default Value: N/A |
| events | No | Array of strings | Definition: Training event that triggers a notification. Constraints: The options are as follows: |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| ssh | No | SSHReq object | Definition: SSH connection information. Constraints: N/A |
Response Parameters
Status code: 200
None
Example Requests
The following shows how to modify a training job with UUID 3faf5c03-aaa1-4cbe-879d-24b05d997347. After the modification, call the API for obtaining a training job(ListTrainingJobs.xml) to view the modified description.
PUT https://{endpoint}/v2/{project_id}/training-jobs/3faf5c03-aaa1-4cbe-879d-24b05d997347
{
"description" : "hahaha"
} Example Responses
Status code: 200
null
Status Codes
| Status Code | Description |
|---|---|
| 200 | No Content |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank 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