更新时间:2022-12-05 GMT+08:00

修改环境信息

功能介绍

此API通过环境ID修改环境信息。

URI

PUT /v2/{project_id}/cas/environments/{environment_id}

表1 路径参数

参数

参数类型

必选

描述

project_id

String

租户项目ID。

environment_id

String

环境ID。

请求消息

表2 请求参数

参数

参数类型

是否必选

描述

name

String

环境名称。

由大小写英文字母、数字、中划线(-)、下划线(_)组成,并以大小写英文字母开头,大小写英文字母或者数字结尾,长度为2~64个字符。

alias

String

环境别名。

最大长度为64个字符。

description

String

环境描述。

最大长度为128个字符。

响应消息

表3 响应参数

参数

参数类型

描述

id

String

环境ID

name

String

环境名称

alias

String

环境别名

description

String

环境描述

project_id

String

项目ID

enterprise_project_id

String

企业项目ID

charge_mode

String

固定值:provided。

vpc_id

String

虚拟私有云ID

base_resources

Array of objects

基础资源,请参考表4

optional_resources

Array of objects

可选资源,请参考表4

creator

String

创建人

create_time

Integer

创建时间

update_time

Integer

修改时间

表4 resources参数

参数

参数类型

描述

id

String

资源ID

name

String

资源名称

type

String

基础资源:cce、ecs

可选资源:dcs、elb等其他类型

示例

请求示例

{
	"name": "development-env2",
	"description": "here is description"
}

响应示例

{
	"id": "00078e9d-a61c-476e-ac63-a10c9cb2638e",
	"name": "development-env2",
	"alias": null,
	"description": "here is description",
	"project_id": "e7d2e9c589e5445e808a8ff0d1235aca",
	"enterprise_project_id": "0",
	"charge_mode": "provided",
	"vpc_id": "29d55020-ae0e-4a18-871c-93e6976ee7bd",
	"base_resources": [
		{
			"id": "523498f1-36c4-11eb-ae36-0255ac1000c2",
			"type": "cce",
			"name": "cce-test"
		}
	],
	"optional_resources": [
		{
			"id": "9963306a-791e-468c-9306-cf80a9d00298",
			"type": "elb",
			"name": "elb-2dd2"
		}
	],
	"creator": "ss-test",
	"create_time": 1610418873730,
	"update_time": 1610420992462
}

状态码

表5 状态码说明

状态码

描述

200

操作成功。

400

错误的请求。

404

请求对象不存在。

500

内部错误。

错误码

错误码格式为:SVCSTG.00100.[Error_ID],例如:SVCSTG.00100400。错误码说明请参考应用管理API错误码