Help Center/ ModelArts/ API Reference/ Training Management/ Updating Training Experiment Information
Updated on 2026-07-24 GMT+08:00

Updating Training Experiment Information

Function

This API is used to modify the configuration of an existing training experiment on ModelArts.

This API is used when you need to modify the parameters of a training experiment, such as the experiment name and description. Before using this API, ensure that you have logged in to ModelArts and have the permission to modify training experiments. You also need to provide a valid experiment ID and the configuration information to be updated. After the update, the system adjusts the training experiment settings based on the new configuration information. If the experiment ID is invalid, the configuration information is invalid, 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.

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, no identity policy-based permission required for calling this API.

URI

PUT /v2/{project_id}/training-experiments/{experiment_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

experiment_id

Yes

String

Definition: Training experiment ID. Obtain it when creating a training job.

Constraints: N/A

Range: N/A

Default Value: N/A

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

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

name

No

String

Definition: Name of the training experiment.

Constraints: N/A

Range: N/A

Default Value: N/A

description

No

String

Definition: Description of the training experiment.

Constraints: N/A

Range: N/A

Default Value: N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

name

String

Definition: Name of the training experiment.

Range: N/A

description

String

Definition: Description of the training experiment.

Range: N/A

Example Requests

Update the name and description.

PUT https://{endpoint}/v2/{project_id}/training-experiments/fa412c98-6d94-42a2-891a-99cd1da93916

{
  "name" : "name",
  "description" : "description"
}

Example Responses

Status code: 200

OK

{
  "name" : "name",
  "description" : "description"
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.