# 创建流水线环境
#### 功能介绍
此API用于修改流水线的环境。
#### URI
POST /cpepipeline/v2/environments
#### 请求消息
表1请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                          |
|:---|:---|:---|:---|
| Content-Type | 是    | String | 消息体的类型（格式），默认取值为"application/json;charset=utf8"。                                                                                            |
| X-Auth-Token | 是    | String | 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html) |
   
表2请求Body参数 
| 参数          | 是否必选 | 参数类型             | 描述                |
|:---|:---|:---|:---|
| name        | 是    | String           | 环境名称。             |
| displayName | 是    | String           | 环境显示名称，不填与name一致。 |
| description | 否    | String           | 环境描述。             |
| tasks       | 是    | Array of objects | 环境任务。             |
   
表3tasks 
| 参数         | 是否必选 | 参数类型    | 描述                                                            |
|:---|:---|:---|:---|
| name       | 是    | String  | 任务名称。                                                         |
| orderIndex | 是    | Integer | 任务执行顺序。                                                       |
| taskTypeId | 是    | Object  | 任务类型参数，详情请见[表4]。 |
| input      | 是    | Object  | 任务输入，详情请见[表5]        |
   
 表4taskTypeId 
| 参数       | 是否必选 | 参数类型   | 描述     |
|:---|:---|:---|:---|
| category | 是    | String | 任务目录。  |
| owner    | 是    | String | 任务所有者。 |
| provider | 是    | String | 任务提供方。 |
   
 表5input 
| 参数           | 是否必选 | 参数类型   | 描述      |
|:---|:---|:---|:---|
| instanceId   | 否    | String | 组件实例ID。 |
| appName      | 否    | String | 组件名称。   |
| modifiedPath | 否    | String | 产物路径。   |
| version      | 否    | String | 修改版本。   |
   
#### 响应消息
表6响应参数 
| 参数         | 参数类型    | 描述                                                           |
|:---|:---|:---|
| id         | String  | 环境ID。                                                        |
| name       | String  | 环境名称。                                                        |
| creator    | String  | 环境创建者。                                                       |
| revisor    | String  | 环境保存者。                                                       |
| created_at | Integer | 创建时间。                                                        |
| updated_at | Integer | 更新时间。                                                        |
| status     | Integer | 环境状态。                                                        |
| project_id | String  | 项目ID。                                                        |
| detail     | String  | 环境详细信息，详情请见[表7]。 |
   
 表7detail 
| 参数    | 参数类型   | 描述                                                       |
|:---|:---|:---|
| name  | String | 环境名称。                                                    |
| tasks | String | 环境任务，详情请见[表8]。 |
   
 表8tasks 
| 参数           | 参数类型    | 描述                                                            |
|:---|:---|:---|
| id           | Integer | 任务ID。                                                         |
| name         | String  | 任务名称。                                                         |
| displayName  | String  | 任务显示名称。                                                       |
| input        | Object  | 任务输入参数，详情请见[表10]。  |
| status       | Integer | 任务状态。                                                         |
| errorDetails | String  | 任务报错信息。                                                       |
| stageName    | String  | 阶段类型。                                                         |
| taskTypeId   | Object  | 任务类型参数，详情请见[表4]。 |
   
表9taskTypeId 
| 参数       | 参数类型   | 描述     |
|:---|:---|:---|
| category | String | 任务目录。  |
| owner    | String | 任务所有者。 |
| provider | String | 任务提供方。 |
| type     | String | 任务类型。  |
   
 表10input 
| 参数           | 参数类型   | 描述      |
|:---|:---|:---|
| instanceId   | String | 组件实例ID。 |
| appName      | String | 组件名称。   |
| modifiedPath | String | 产物路径。   |
| version      | String | 修改版本。   |
   
#### 请求示例
```
{
    "id": "805f7ec2-7c05-417b-bc3e-5f6035edb673",
    "name": "Environment-894g",
    "creator": "servicestage_iam5",
    "revisor": "servicestage_iam5",
    "created_at": 1753165301070,
    "updated_at": 1753165301070,
    "status": 0,
    "project_id": "59336be373624a998b2527fdb9913266",
    "detail": {
        "name": "Environment-894g",
        "tasks": [
            {
                "id": 0,
                "name": "Deploy",
                "display_name": "Deploy",
                "task_type_id": {
                    "category": "Deploy",
                    "owner": "System",
                    "provider": "ENV-CAS",
                    "type": null
                },
                "input": {
                    "instanceId": "20acd377-0659-478c-b563-c2585166278e",
                    "appName": "ghy-test-0707-1-2",
                    "modifiedPath": "{\"ghy-test-0707-1-2\":\"${Artifacts_ghy-test-comp-0626-3-62e353_Output_release@PublishBuildImage}\"}",
                    "version": "1.0.0"
                },
                "output": {},
                "status": null,
                "order_index": 0,
                "skipped": false,
                "group_index": null,
                "delay_time": 0,
                "error_details": null,
                "stage_name": null
            }
        ]
    }
}
```
#### 响应示例
```
{
    "id": "805f7ec2-7c05-417b-bc3e-5f6035edb673",
    "name": "Environment-894g",
    "creator": "servicestage_iam5",
    "revisor": "servicestage_iam5",
    "created_at": 1753165301070,
    "updated_at": 1753165301070,
    "status": 0,
    "project_id": "59336be373624a998b2527fdb9913266",
    "detail": {
        "name": "Environment-894g",
        "tasks": [
            {
                "id": 0,
                "name": "Deploy",
                "displayName": "Deploy",
                "taskTypeId": {
                    "category": "Deploy",
                    "owner": "System",
                    "provider": "ENV-CAS",
                    "type": null
                },
                "input": {
                    "instanceId": "20acd377-0659-478c-b563-c2585166278e",
                    "appName": "ghy-test-0707-1-2",
                    "modifiedPath": "{\"ghy-test-0707-1-2\":\"${Artifacts_ghy-test-comp-0626-3-62e353_Output_release@PublishBuildImage}\"}",
                    "version": "1.0.0"
                },
                "output": {},
                "status": null,
                "skipped": false
            }
        ]
    }
}
```
#### 状态码
| 状态码 | 描述       |
|:---|:---|
| 200 | 操作成功。    |
| 400 | 错误的请求。   |
| 404 | 请求对象不存在。 |
| 500 | 内部错误。    |
   
#### 错误码
请参考[ServiceStage错误码](https://support.huaweicloud.com/api-servicestage/servicestage_06_0162.html)。