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

Modifying the Description of a Training Job

Function

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

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: ID of a training job

Constraints: For details, see Querying a Training Job List.

Range: N/A

Default Value: N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

description

No

String

Training job description, which consists of 0 to 256 characters. The default value is 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