文档首页/ 应用管理与运维平台 ServiceStage/ API参考/ 应用管理API（v3版本）/ 环境/ 根据环境ID修改环境
更新时间：2025-07-08 GMT+08:00
查看PDF
分享

根据环境ID修改环境

功能介绍

此API用于通过环境ID修改环境。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

environment_id

是

String

环境ID。获取方法，请参考获取所有环境。

请求消息

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

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

X-Auth-Token

是

String

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

参数

是否必选

参数类型

描述

name

是

String

环境名称。

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

description

否

String

环境描述。

最大长度为128个字符。

labels

否

Array of objects

标签，可使用标签管理服务通过标签过滤资源，请参考表4。

同一个环境下最多可以添加20个标签。

enterprise_project_id

否

String

企业项目ID。

如果不配置此参数，则默认企业项目为“default”，ID为0。

configuration

否

Object

环境级环境变量，请参考表5。
表4 labels

参数

是否必选

参数类型

描述

key

是

String

标签名称。

标签用于标识资源，当您拥有相同类型的许多资源时，可以使用标签按各种维度（例如用途、所有者或环境）对资源进行分类。

长度为1到36个字符，只能包含数字、英文字母、下划线（_）、中划线（-）或中文。

value

是

String

标签值。

长度为1到43个字符，只能包含数字、英文字母、下划线（_）、点（.）、中划线（-）或中文。
表5 configuration

参数

是否必选

参数类型

描述

resource_envs

否

Array of objects

环境绑定的资源变量，请参考表6。

envs

否

Array of objects

环境级环境变量，请参考表7。
表6 resource_env

参数

是否必选

参数类型

描述

resource_id

是

String

环境绑定的资源变量关联的资源ID。

resource_name

是

String

环境绑定的资源变量关联的资源名称。

resource_type

是

String

环境绑定的资源变量关联的资源类型。

envs

是

Array of objects

环境绑定的资源变量，请参考表7。
表7 config_env

参数

是否必选

参数类型

描述

name

是

String

环境级环境变量的键。

value

是

String

环境级环境变量的值。

响应消息

表8 响应参数

参数

参数类型

描述

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

标签，可使用标签管理服务通过标签过滤资源，请参考表9。

resources

Array of objects

资源，请参考表10。

resource_create_mode

String

资源配置模式。

  • none：纳管资源。

config_mode

String

配置模式。

  • ui：基于UI页面配置部署。

configuration

Object

环境级环境变量，请参考表12。
表9 labels

参数

参数类型

描述

key

String

标签名称。

value

String

标签值。
表10 resources

参数

参数类型

描述

id

String

资源ID。

name

String

资源名称。

type

String

资源类型。

  • vpc，虚拟私有云。
  • eip，弹性IP。
  • elb，弹性负载均衡。
  • cce，云容器引擎。
  • ecs，弹性云服务器。
  • as，弹性伸缩组。
  • cse，ServiceComb引擎。
  • nacos，注册配置中心。
  • dcs，分布式缓存服务。
  • rds，云数据库。
  • subnet，子网。
  • acl，网络ACL。
  • gaussdb，云数据库GaussDB。
  • dms_rocketmq，分布式消息服务RocketMQ。
  • customServer，自定义服务器。
  • css_es，云搜索服务Elasticsearch。
  • custom_k8s，自定义kubernetes集群。

ip

String

当资源类型为customServer时，指定自定义服务器的IP。

parameters

Map<String, String>

资源参数，请参考表11。

alias

String

资源别名。
表11 parameters

参数

参数类型

描述

kube_config

String

Kubernetes连接配置文件。

资源类型为custom_k8s时返回此参数。
表12 configuration

参数

参数类型

描述

resource_envs

Array of objects

环境绑定的资源变量，请参考表13。

envs

Array of objects

环境级环境变量，请参考表14。
表13 resource_env

参数

参数类型

描述

resource_id

String

环境绑定的资源变量关联的资源ID。

resource_name

String

环境绑定的资源变量关联的资源名称。

resource_type

String

环境绑定的资源变量关联的资源类型。

envs

Array of objects

环境绑定的资源变量，请参考表14。
表14 config_env

参数

参数类型

描述

name

String

环境级环境变量的键。

value

String

环境级环境变量的值。

请求示例

修改环境名称为development-env，描述设置为空，为环境增加键值对为"test": "value"的标签。

{
	"name": "development-env",
	"description": "",
        "labels": [
            {
                "key": "test",
                "value": "value"
            }
        ]
}

响应示例

{
	"id": "00078e9d-a61c-476e-ac63-a10c9cb2638e",
	"name": "development-env",
	"description": "",
	"project_id": "e7d2e9c589e5445e808a8ff0d1235aca",
	"enterprise_project_id": "0",
        "deploy_mode": "virtualmachine",
	"vpc_id": "29d55020-ae0e-4a18-871c-93e6976ee7bd",	
	"creator": "ss-test",
	"create_time": 1610418873730,
	"update_time": 1610418873730,
        "resources": [
            {
                "id": "329b135e-7b31-4ea6-afb9-b69017bd0a80",
                "type": "ecs",
                "name": "ecs-test"
            }
        ],
        "labels": [
            {
                "key": "test",
                "value": "value"
            }
        ]
}

状态码

状态码

描述

200

操作成功。

400

错误的请求。

404

请求对象不存在。

500

内部错误。

错误码

请参考ServiceStage错误码。

父主题： 环境