Help Center/ ModelArts/ API Reference/ Training Management/ Modifying the Description of a Training Job
Updated on 2025-11-19 GMT+08:00
View PDF
Share

Modifying the Description of a Training Job

Function

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

This API is used when you need to update the description of a training job. Before using this API, ensure that the training job exists and you have the required permission. After the update, the description of the training job is updated. If the training job does not exist or you do not have the required 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.

URI

PUT /v2/{project_id}/training-jobs/{training_job_id}

Table 1 Path Parameters

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

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

description

No

String

Definition: Training job description.

Constraints: The value can contain at most 256 characters.

Range: N/A

Default Value: NULL

Response Parameters

Status code: 200

No Content

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

No Content

null

Status Codes

Status Code

Description

200

No Content

Error Codes

See Error Codes.

Parent topic: Training Management