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

根据环境ID修改环境 - ModifyEnvironmentBasedOnTheEnvironmentID

功能介绍

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

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

environment_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求消息

表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。

约束限制：

需要开通企业项目功能后才可配置企业项目。

取值范围：

不涉及

默认取值：

不涉及

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

参数解释：

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

取值范围：

  • vpc：虚拟私有云。
  • eip：弹性IP。
  • elb：弹性负载均衡。
  • cce：云容器引擎。
  • ecs：弹性云服务器。
  • as：弹性伸缩组。
  • cse：ServiceComb引擎。
  • nacos：注册配置中心。
  • ms_gateway：应用网关。

    仅“华东-上海一”、“亚太-新加坡”区域支持纳管应用网关，用于使用全链路流量控制功能。

  • dcs：分布式缓存服务。
  • rds：云数据库RDS。
  • subnet：子网。
  • acl：网络ACL。
  • customServer：自定义服务器。
  • gaussdb：云数据库GaussDB。
  • dms_rocketmq：分布式消息服务RocketMQ。
  • css_es：云搜索服务Elasticsearch。
  • custom_k8s：自定义kubernetes集群。

默认取值：

不涉及

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：注册配置中心。
  • ms_gateway：应用网关。

    仅“华东-上海一”、“亚太-新加坡”区域支持纳管应用网关，用于使用全链路流量控制功能。

  • dcs：分布式缓存服务。
  • rds：云数据库RDS。
  • subnet：子网。
  • acl：网络ACL。
  • customServer：自定义服务器。
  • gaussdb：云数据库GaussDB。
  • dms_rocketmq：分布式消息服务RocketMQ。
  • 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

参数解释：

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

取值范围：

  • vpc：虚拟私有云。
  • eip：弹性IP。
  • elb：弹性负载均衡。
  • cce：云容器引擎。
  • ecs：弹性云服务器。
  • as：弹性伸缩组。
  • cse：ServiceComb引擎。
  • nacos：注册配置中心。
  • ms_gateway：应用网关。

    仅“华东-上海一”、“亚太-新加坡”区域支持纳管应用网关，用于使用全链路流量控制功能。

  • dcs：分布式缓存服务。
  • rds：云数据库RDS。
  • subnet：子网。
  • acl：网络ACL。
  • customServer：自定义服务器。
  • gaussdb：云数据库GaussDB。
  • dms_rocketmq：分布式消息服务RocketMQ。
  • css_es：云搜索服务Elasticsearch。
  • custom_k8s：自定义kubernetes集群。

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错误码。

父主题： 环境

相关文档