doc-exports/docs/modelarts/api-ref/modelarts_03_0052.html

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 Parameters

Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain a project ID, see Obtaining a Project ID and Name.
job_id	Yes	Long	ID of a training job

Request Body

Table 2 describes the request parameters.

Table 2 Parameters

Parameter	Mandatory	Type	Description
job_desc	Yes	String	Description of a training job. The value must contain 0 to 256 characters.

Response Body

Table 3 describes the response parameters.

Table 3 Parameters

Parameter	Type	Description
is_success	Boolean	Whether the request is successful.
error_message	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 Codes. This parameter is not included when the API call succeeds.

Sample Request

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

PUT    https://endpoint/v1/{project_id}/training-jobs/10
{
    "job_desc": "This is a ModelArts job"
}

Sample Response

• Successful response

  {
      "is_success": true
  }

• Failed response

  {
      "is_success": false,
      "error_message": "Error string",
      "error_code": "ModelArts.0105"
  }

Status Code

For details about the status code, see Status Code.

Parent topic: Training Jobs