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

Verifying the Training Experiment Name

Function

This API is used to check whether the training experiment name is duplicate before training experiment creation.

This API is used when you need to verify whether the custom experiment name already exists. Before using this API, ensure that you have the permission to create experiments. After the query, the system returns the result of whether the experiment name is duplicate. If you do not have the permission to perform operations, 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

GET /v2/{project_id}/training-experiment-names

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition: User 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

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

workspace_id

No

String

Definition: Workspace ID. .

Constraints: There must be a workspace in use.

Range: N/A

Default Value: 0

experiment_name

Yes

String

Definition: Experiment name.

Constraints: The value can contain at most 64 characters. Special characters are not allowed.

Range: N/A

Default Value: N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

is_duplicate

Boolean

Definition: Specifies whether the value is duplicate.

Constraints: N/A

Range

  • true (duplicate)

  • false (not duplicate)

Default Value: N/A

Example Requests

GET https://endpoint/v2/{project_id}/training-experiment-names?experiment_name=test&workspace_id=0

Example Responses

Status code: 200

OK

{
  "is_duplicate" : true
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.