Obtaining the Training Experiment List

Function

This API is used to obtain the list of created training experiments created on ModelArts.

This API is used when you need to view the information about training experiments, such as the experiment name, description, and creation time. Before using this API, ensure that you have logged in to ModelArts and have the permission to view training experiments. After the query, the system returns the list of training experiments that meet the query criteria. If you do not have the permission to perform operations or the query criteria are invalid, 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-experiments

**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

**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
limit	No	Integer	Definition: Number of returned records. Constraints: N/A Range: N/A Default Value: N/A
offset	No	Integer	Definition: Offset of data records Constraints: N/A Range: N/A Default Value: N/A
sort_by	No	String	Definition: Sorting field. For example, if sort_by is set to update_time, items are sorted by update time. Constraints: N/A. Range: update_time: Update time. name: Experiment name. create_time: Creation time. Default Value: N/A.
order	No	String	Definition: Sorting mode. Constraints: This parameter must be used together with sort_by. Range asc: ascending order desc: descending order Default Value: desc

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total	Integer	Definition: Total number of queried training experiments. Range: N/A
count	Integer	Definition: Total number of training experiments that meet the search criteria. Range: N/A
limit	Integer	Definition: Maximum number of training experiments that meet the search criteria. Range: N/A
offset	Integer	Definition: Query offset of all training experiments. Range: N/A
sort_by	String	Definition: Sorting dependent field of all training experiments. Range: N/A
order	String	Definition: Sorting mode of all training experiments. Range: - asc: ascending order. - desc: descending order.
items	Array of TrainingExperimentResponse objects	Definition: Details of all training experiments that meet the search criteria.

**Table 4** TrainingExperimentResponse
Parameter	Type	Description
metadata	TrainingExperimentResponseMetadata object	Definition: Training experiment data.
statistic	TrainingExperimentStatistic object	Definition: Statistics of the training experiment.

**Table 5** TrainingExperimentResponseMetadata
Parameter	Type	Description
name	String	Definition: Experiment name. Range: N/A
description	String	Definition: Description. Range: N/A
workspace_id	String	Definition: Workspace ID. Range: N/A
create_time	Long	Definition: Creation time. Range: N/A
update_time	Long	Definition: Update time. Range: N/A
id	String	Definition: Experiment ID. Range: N/A

**Table 6** TrainingExperimentStatistic
Parameter	Type	Description
job_count	Integer	Definition: Total number of training jobs in the current experiment. Range: N/A

Example Requests

GET https://endpoint/v2/{project_id}/training-experiments?limit=50&offset=0&sort_by=update_time&order=desc&workspace_id=0

Example Responses

Status code: 200

{
  "total" : 2,
  "count" : 2,
  "limit" : 50,
  "offset" : 0,
  "sort_by" : "update_time",
  "order" : "desc",
  "items" : [ {
    "metadata" : {
      "id" : "8f583924-3e69-46f0-a18a-12de68d99295",
      "name" : "autotest_experimen_w0v04g",
      "description" : "Create an experiment group when creating a training job.",
      "create_time" : 1749718901720,
      "workspace_id" : "0",
      "update_time" : 1749718902000
    },
    "statistic" : {
      "job_count" : 0
    }
  }, {
    "metadata" : {
      "id" : "a2b141a8-7f76-497b-ae82-e8510c4a0168",
      "name" : "autotest_experimen_121643",
      "description" : "Obtain the job experiment list.",
      "create_time" : 1749718899517,
      "workspace_id" : "0",
      "update_time" : 1749718899000
    },
    "statistic" : {
      "job_count" : 1
    }
  } ]
}