Help Center> ModelArts> API Reference> Training Management> Training Jobs> Modifying the Description of a Training Job
View PDF

Modifying the Description of a Training Job

Function

This API is used to modify the description of a training job.

URI

PUT /v1/{project_id}/training-jobs/{job_id}

Table 1 describes the required parameters.
Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

job_id

Yes

Long

ID of a training job

Request Body

Table 2 describes the request parameters.
Table 2 Parameter description

Parameter

Mandatory

Type

Description

job_desc

No

String

Description of a training job. The value is a string of 0 to 256 characters.

Response Body

Table 3 describes the response parameters.
Table 3 Parameter description

Parameter

Type

Description

is_success

Boolean

Whether the request is successful

error_msg

String

Error message of a failed API call.

This parameter is not included when the API call succeeds.

error_code

String

Error code of a failed API call. For details, see Error Code. This parameter is not included when the API call succeeds.

Samples

The following shows how to modify the description of the job whose job_id is 10.

  • Sample request 
    PUT    https://endpoint/v1/{project_id}/training-jobs/10
{
    "job_desc": "This is a ModelArts job"
}
  • Successful sample response 
    {
    "is_success": true
}
  • Failed sample response 
    {
    "is_success": false,
    "error_msg": "Error string",
    "error_code": "ModelArts.0105"
}

Status Code

For details about the status code, see Status Code.

Parent topic: Training Jobs