# 创建训练实验 - CreateTrainingExperiment
#### 功能介绍
创建训练实验接口用于在ModelArts平台上创建新的实验分类。
该接口适用于以下场景：当用户需要将训练作业放入实验中分类，有序地进行管理，可以通过此接口创建训练实验，常用于多任务的版本管理等场景。使用该接口的前提条件是用户已登录ModelArts平台并具有创建训练实验的权限。创建操作完成后，系统将返回训练实验的详细信息，包括实验ID、当前实验下的训练作业总个数等。若用户无权限操作，接口将返回相应的错误信息。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=CreateTrainingExperiment)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-modelarts/modelarts_03_0138.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                              | 访问级别  | 资源类型（\*为必须）        | 条件键                   | 别名                        | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | modelarts:trainExperiment:create | Write | workspace \*       | g:EnterpriseProjectId | modelarts:trainJob:create | -      |
  | modelarts:trainExperiment:create | Write | trainExperiment \* | -                     | modelarts:trainJob:create | -      |
     
  
 
#### URI
POST /v2/{project_id}/training-experiments
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|:---|
| project_id | 是    | String | **参数解释** ：用户项目ID。获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-modelarts/modelarts_03_0147.html)。 **约束限制**：1 - 64字符，字母、数字和中划线。 **取值范围**：不涉及。 **默认取值**：不涉及。 |
   
#### 请求参数
表2请求Body参数 
| 参数       | 是否必选 | 参数类型                                                                                                                                              | 描述                                                                                                            |
|:---|:---|:---|:---|
| metadata | 是    | [TrainingExperimentRequestMetadata] object | **参数解释**：训练实验创建参数。 **约束限制**：不涉及。 |
   
 表3TrainingExperimentRequestMetadata 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                        |
|:---|:---|:---|:---|
| name         | 是    | String | **参数解释**：实验名称。 **约束限制**：最大长度128，只能由字母、数字、下划线、中划线和中文组成。 **取值范围**：不涉及。 **默认取值**：不涉及。 |
| description  | 否    | String | **参数解释**：描述信息。 **约束限制**：最大长度512，不能包含字符\<和\>。 **取值范围**：不涉及。 **默认取值**：不涉及。           |
| workspace_id | 否    | String | **参数解释**：工作空间ID。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：默认为0。                        |
   
#### 响应参数
**状态码：201**
表4响应Body参数 
| 参数        | 参数类型                                                                                                                                                 | 描述                  |
|:---|:---|:---|
| metadata  | [TrainingExperimentResponseMetadata] object | **参数解释**：训练实验数据。    |
| statistic | [TrainingExperimentStatistic] object               | **参数解释**：训练实验的统计数据。 |
   
 表5TrainingExperimentResponseMetadata 
| 参数           | 参数类型   | 描述                                                                                                          |
|:---|:---|:---|
| name         | String | **参数解释**：实验名称。 **取值范围**：不涉及。   |
| description  | String | **参数解释**：描述信息。 **取值范围**：不涉及。   |
| workspace_id | String | **参数解释**：工作空间ID。 **取值范围**：不涉及。 |
| create_time  | Long   | **参数解释**：创建时间。 **取值范围**：不涉及。   |
| update_time  | Long   | **参数解释**：更新时间。 **取值范围**：不涉及。   |
| id           | String | **参数解释**：实验ID。 **取值范围**：不涉及。   |
   
 表6TrainingExperimentStatistic 
| 参数        | 参数类型    | 描述                                                                                                                 |
|:---|:---|:---|
| job_count | Integer | **参数解释**：当前实验下的训练作业总个数。 **取值范围**：不涉及。 |
   
#### 请求示例
创建实验。
```
POST https://{endpoint}/v2/{project_id}/training-experiments
{
  "metadata" : {
    "name" : "test",
    "description" : "demo",
    "workspace_id" : "0"
  }
}
```
#### 响应示例
**状态码：201**
```
{
  "metadata" : {
    "id" : "6ccc15e6-8a81-4d8e-8bee-53401d850639",
    "name" : "test",
    "description" : "demo",
    "create_time" : 1731552542622,
    "workspace_id" : "0",
    "update_time" : 1731552542000
  },
  "statistic" : {
    "job_count" : 0
  }
}
```
#### 状态码
| 状态码 | 描述 |
|:---|:---|
| 201 | OK |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。