文档首页/ 应用管理与运维平台 ServiceStage/ API参考/ 历史API/ 应用管理（v2版本）/ 环境/ 创建环境
更新时间：2024-10-16 GMT+08:00
查看PDF
分享

创建环境

功能介绍

此API用来创建环境。

URI

POST /v2/{project_id}/cas/environments

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目ID。获取方法，请参考获取项目ID。

请求消息

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

消息体的类型（格式），默认取值为“application/json;charset=utf8”。

X-Auth-Token

是

String

调用接口的认证方式分为Token和AK/SK两种。如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。
表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

环境名称。

由英文字母、数字、中划线（-）、下划线（_）组成，并以英文字母开头，英文字母或者数字结尾，英文字母不区分大小写，长度为2~64个字符。

alias

否

String

环境别名。

最大长度为64个字符。

deploy_mode

是

String

指定环境类型。

  • virtualmachine：虚拟机。
  • container：Kubernetes。
  • mixed ：虚拟机和Kubernetes。

description

否

String

环境描述。

最大长度为128个字符。

enterprise_project_id

否

String

企业项目ID。

charge_mode

否

String

收费模式，支持provided、on_demanded、monthly。默认provided，表示使用用户提供的已有资源，无需收费。on_demanded表示按需收费，monthly表示包月收费。

vpc_id

是

String

虚拟私有云ID。

base_resources

是

Array of objects

基础资源，请参考表4。

optional_resources

否

Array of objects

可选资源，请参考表4。
表4 resources

参数

是否必选

参数类型

描述

id

是

String

资源ID。

type

是

String

基础资源：cce、ecs、as。

可选资源：rds、dcs、elb、cse等其他类型。

name

否

String

资源名称。

响应消息

表5 响应参数

参数

参数类型

描述

id

String

环境ID。

name

String

环境名称。

alias

String

环境别名。

description

String

环境描述。

project_id

String

项目ID。

enterprise_project_id

String

企业项目ID。

charge_mode

String

收费模式。

deploy_mode

String

环境类型。

  • virtualmachine：虚拟机。
  • container：Kubernetes。
  • mixed ：虚拟机和Kubernetes。

vpc_id

String

虚拟私有云ID。

base_resources

Array of objects

基础资源，请参考表6，返回为空。

optional_resources

Array of objects

可选资源，请参考表6，返回为空。

creator

String

创建人。

create_time

Integer

创建时间。

update_time

Integer

修改时间。
表6 resources

参数

参数类型

描述

id

String

资源ID。

name

String

资源名称。

type

String

基础资源：cce、ecs、as。

可选资源：rds、dcs、elb、cse等其他类型。

请求示例

创建一个名称为development-env的“虚拟机”类型的环境，环境所在VPC的id为29d55020-ae0e-4a18-871c-93e6976ee7bd。

{
	"name": "development-env",
	"description": "",
	"charge_mode": "provided",
        "deploy_mode": "container",
	"vpc_id": "29d55020-ae0e-4a18-871c-93e6976ee7bd",
        "base_resources": [
                {
                        "id": "b6862a62-d916-11e9-bdf1-0255ac101fd9",
                        "type": "cce"
                }
        ],   
        "optional_resources": [
                {
                        "id": "default",
                        "type": "cse"
                }
        ]
}

响应示例

{
	"id": "00078e9d-a61c-476e-ac63-a10c9cb2638e",
	"name": "development-env",
	"alias": null,
	"description": "",
	"project_id": "e7d2e9c589e5445e808a8ff0d1235aca",
	"enterprise_project_id": "0",
	"charge_mode": "provided",
        "deploy_mode": "container",
	"vpc_id": "29d55020-ae0e-4a18-871c-93e6976ee7bd",	
        "base_resources": [
                {
                        "id": "b6862a62-d916-11e9-bdf1-0255ac101fd9",
                        "type": "cce"
                }
        ],   
        "optional_resources": [
                {
                        "id": "default",
                        "type": "cse"
                }
        ],
	"creator": "ss-test",
	"create_time": 1610418873730,
	"update_time": 1610418873730
}

状态码

状态码

描述

200

操作成功。

400

错误的请求。

404

请求对象不存在。

500

内部错误。

错误码

错误码格式为：SVCSTG.00100.[Error_ID]，例如：SVCSTG.00100400。错误码说明请参考ServiceStage错误码。

父主题： 环境