接口功能介绍
调用createEnv接口在指定项目下创建环境
接口约束
无
URI
POST /v1/env/createEnv
路径参数
无
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池ID,请参考调用前必知-概述 | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
envCode | 是 | String | 环境code,长度为3~30个字符,开头为小写字母,后可为小写字母,中划线以及数字 | test-env | |
envName | 是 | String | 环境名称, 名称长度为3~30个字符 | 测试环境 | |
envType | 是 | String | 环境类型 DEVELOP 开发环境,TEST 测试环境,PRE_ONLINE 预发布环境,ONLINE 生产环境 | DEVELOP | |
projectId | 是 | String | 项目ID | 29b25b16-0b71-48ae-8e82-3746a052b98d | |
resPoolId | 是 | String | 资源池ID | bb9fdb42056f11eda1610242ac110002 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | String | 返回码 取值范围:2000 success |
2000 | |
returnObj | Object | 返回对象 | returnObj | |
message | String | 消息内容 | ||
error | String | 调用错误时返回的错误编码 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
envUuid | String | 项目ID | 29b25b16-0b71-48ae-8e82-3746a052b98d |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"envCode": "test-env",
"envName": "测试环境",
"envType": "DEVELOP",
"projectId": "29b25b16-0b71-48ae-8e82-3746a052b98d",
"resPoolId": "bb9fdb42056f11eda1610242ac110002"
}
响应示例
{
"statusCode": "2000",
"returnObj": {
"envUuid": "29b25b16-0b71-48ae-8e82-3746a052b98d "
},
"message": "成功"
}
状态码
请参考 状态码
错误码
请参考 错误码