修改环境信息
功能介绍
此API通过环境ID修改环境信息。
调试
您可以在API Explorer中调试该接口。
URI
PUT /v2/{project_id}/cas/environments/{environment_id}
请求消息
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Content-Type |
是 |
String |
消息体的类型（格式），默认取值为“application/json;charset=utf8”。 |
|
X-Auth-Token |
是 |
String |
调用接口的认证方式分为Token和AK/SK两种。如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
否 |
String |
环境名称。 由英文字母、数字、中划线（-）、下划线（_）组成，并以英文字母开头，英文字母或者数字结尾，英文字母不区分大小写，长度为2~64个字符。 |
|
alias |
否 |
String |
环境别名。 最大长度为64个字符。 |
|
description |
否 |
String |
环境描述。 最大长度为128个字符。 |
响应消息
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
环境ID。 |
|
name |
String |
环境名称。 |
|
alias |
String |
环境别名。 |
|
description |
String |
环境描述。 |
|
project_id |
String |
项目ID。 |
|
enterprise_project_id |
String |
企业项目ID。 |
|
charge_mode |
String |
收费模式。 |
|
deploy_mode |
String |
环境类型。
|
|
vpc_id |
String |
虚拟私有云ID。 |
|
base_resources |
Array of objects |
基础资源，请参考表5。 |
|
optional_resources |
Array of objects |
可选资源，请参考表5。 |
|
creator |
String |
创建人。 |
|
create_time |
Integer |
创建时间。 |
|
update_time |
Integer |
修改时间。 |
请求示例
修改名称为development-env2的环境，增加环境描述信息。
{
"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",
"deploy_mode": "container",
"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
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
操作成功。 |
|
400 |
错误的请求。 |
|
404 |
请求对象不存在。 |
|
500 |
内部错误。 |
错误码
请参考ServiceStage错误码。
