创建环境
功能介绍
环境是用于组件部署和运行的计算(如云容器引擎 CCE、弹性云服务器 ECS等)、网络(如弹性负载均衡 ELB、弹性IP EIP等)和中间件(如分布式缓存 DCS、云数据库 RDS等)等基础资源的集合。ServiceStage把多种基础资源组合为一个环境,如:开发环境、测试环境、预生产环境和生产环境。按环境维度来管理资源、部署组件,可以减少具体基础资源运维管理的复杂性。
此API用来创建环境。
调试
您可以在API Explorer中调试该接口。
URI
POST /v3/{project_id}/cas/environments
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户项目ID。获取方法,请参考获取项目ID。 |
请求消息
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Content-Type |
是 |
String |
消息体的类型(格式),默认取值为“application/json”。 |
X-Auth-Token |
是 |
String |
调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考获取用户Token。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
环境名称。 由英文字母、数字、中划线(-)或下划线(_)组成,并以英文字母开头,英文字母或者数字结尾,英文字母不区分大小写,长度为2~64个字符。 |
deploy_mode |
否 |
String |
环境类型。
|
description |
否 |
String |
环境描述。 最大长度为128个字符。 |
enterprise_project_id |
否 |
String |
企业项目ID。 |
vpc_id |
是 |
String |
虚拟私有云ID。 |
labels |
否 |
Array of objects |
标签,可使用标签管理服务通过标签过滤资源,请参考表4。 同一个环境下最多可以添加20个标签。
说明:
“华东-上海一”、“华东二”区域支持设置“标签”参数。 |
响应消息
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
环境ID。 |
name |
String |
环境名称。 |
description |
String |
环境描述。 |
project_id |
String |
项目ID。 |
enterprise_project_id |
String |
企业项目ID。 |
deploy_mode |
String |
环境类型。 |
vpc_id |
String |
虚拟私有云ID。 |
creator |
String |
环境创建人。 |
create_time |
Integer |
环境创建时间。 |
update_time |
Integer |
环境修改时间。 |
labels |
Array of objects |
标签,可使用标签管理服务通过标签过滤查询资源信息,请参考表6。 |
请求示例
创建名称为env-test的“虚拟机”类型环境,环境所在VPC的id为0c72428b-cd6c-4283-a560-210d3edb49f7。
{ "name": "env-test", "description": "", "enterprise_project_id": "0", "vpc_id": "0c72428b-cd6c-4283-a560-210d3edb49f7", "labels": [ { "key": "aaaaa", "value": "a5" } ], "deploy_mode": "virtualmachine" }
响应示例
{ "id": "c93a5313-d141-4b9f-97ce-b4ce2b3988bd", "name": "test", "description": "", "project_id": "13ae26238d724e54947af3e0fcbef9c3", "enterprise_project_id": "0", "vpc_id": "0c72428b-cd6c-4283-a560-210d3edb49f7", "creator": "ss-test", "create_time": 1681384236023, "update_time": 1681384236023, "deploy_mode": "virtualmachine", "labels": [] }
状态码
状态码 |
描述 |
---|---|
200 |
操作成功。 |
400 |
错误的请求。 |
404 |
请求对象不存在。 |
500 |
内部错误。 |
错误码
错误码格式为:SVCSTG.00100.[Error_ID],例如:SVCSTG.00100400。错误码说明请参考ServiceStage错误码。