文档首页/ 云应用引擎 CAE/ API参考/ CAE API/ 环境/ 创建环境
更新时间：2025-10-22 GMT+08:00
查看PDF
分享

创建环境

功能介绍

创建环境。

URI

POST /v1/{project_id}/cae/environments

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取项目ID请参见获取项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

  • 获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。

    • 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Enterprise-Project-ID

否

String

企业项目ID。

  • 创建环境时，环境会绑定企业项目ID。

  • 最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。

  • 该字段不传（或传为字符串“0”）时，则查询默认企业项目下的资源。

说明：
关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。
表3 请求Body参数

参数

是否必选

参数类型

描述

api_version

是

String

API版本，固定值“v1”，该值不可修改。

kind

是

String

API类型，固定值“Environment”，该值不可修改。

metadata

是

metadata object

请求数据。
表4 metadata

参数

是否必选

参数类型

描述

annotations

否

CreateEnvRequestAnnotations object

name

是

String

环境名称。
表5 annotations

参数

是否必选

参数类型

描述

{自定义key}

否

Map<String,String>

创建环境请求体附加参数。

  • vpc_id：创建环境绑定的VPC的ID。

  • group_name：创建环境绑定的SWR组织的组织名称。

  • type：环境类型，当前仅支持exclusive类型。

  • subnet_id: 创建环境绑定的VPC入网子网的ID。

  • egress_subnet_id: 创建环境绑定的VPC出网子网的ID。

  • elb_id：创建环境绑定的ELB ID

响应参数

状态码：200

表6 响应Body参数

参数

参数类型

描述

job_id

String

任务ID。

请求示例

创建环境，环境名称为“test”，组织名“cae-test”，绑定虚拟私有云VPC。

POST https://{endpoint}/v1/{project_id}/cae/environments

{
  "api_version" : "v1",
  "kind" : "Environment",
  "metadata" : {
    "annotations" : {
      "vpc_id" : "9b320498-6c39-4fe7-a758-79636dd68a82",
      "group_name" : "cae-test",
      "type" : "exclusive",
      "subnet_id" : "1c75734a-132c-459f-86e2-a3db86a66b86",
      "security_group_id" : "e6c5a41d-8f47-48bd-a21b-0a4b10766aef"
    },
    "name" : "test"
  }
}

响应示例

状态码：200

请求成功。

{
  "job_id" : "xxx"
}

状态码

状态码

描述

200

请求成功。

错误码

请参见错误码。

父主题： 环境