文档首页/ 应用管理与运维平台 ServiceStage/ API参考/ 应用管理API（v3版本）/ 环境/ 根据环境ID修改环境
更新时间：2024-10-16 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获取方式，请参考获取用户Token。
表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

环境名称。

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

description

否

String

环境描述。

最大长度为128个字符。

labels

否

Array of objects

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

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

参数

是否必选

参数类型

描述

key

是

String

标签名称。

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

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

value

是

String

标签值。

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

响应消息

表5 响应参数

参数

参数类型

描述

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

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

resources

Array of objects

资源，请参考表7。
表6 labels

参数

参数类型

描述

key

String

标签名称。

value

String

标签值。
表7 resources

参数

参数类型

描述

id

String

资源ID。

name

String

资源名称。

type

String

资源类型。

  • vpc，虚拟私有云。
  • eip，弹性公网IP。
  • elb，弹性负载均衡。
  • cce，云容器引擎。
  • ecs，弹性云服务器。
  • as，弹性伸缩组。
  • cse，微服务引擎。
  • dcs，分布式缓存服务。
  • rds，云数据库。

请求示例

修改环境名称为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

内部错误。

错误码

错误码格式为：SVCSTG.00100.[Error_ID]，例如：SVCSTG.00100400。错误码说明请参考ServiceStage错误码。

父主题： 环境