文档首页> 应用管理与运维平台 ServiceStage> API参考> 应用管理（v2版本）> 环境> 修改环境资源
更新时间：2024-02-06 GMT+08:00
查看PDF

修改环境资源

功能介绍

此API用来修改环境资源。

URI

PATCH /v2/{project_id}/cas/environments/{environment_id}/resources

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

environment_id

是

String

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

请求消息

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

消息体的类型（格式）。

X-Auth-Token

是

String

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

参数

是否必选

参数类型

描述

add_base_resources

否

Array of objects

添加基础资源，请参考表4。

add_optional_resources

否

Array of objects

添加可选资源，请参考表5。

remove_resources

否

Array of objects

移除资源，请参考表6。
表4 add_base_resources参数

参数

是否必选

参数类型

描述

id

是

String

资源ID（为了保证接口调用正常，请您确保调用前输入正确的资源ID）。

name

否

String

资源名称。

type

是

String

基础资源：cce、ecs、as。
表5 add_optional_resources参数

参数

是否必选

参数类型

描述

id

是

String

资源ID（为了保证接口调用正常，请您确保调用前输入正确的资源ID）。

name

否

String

资源名称。

type

是

String

可选资源：rds、dcs、elb、cse等其他类型。
表6 remove_resources参数

参数

是否必选

参数类型

描述

id

是

String

资源ID（为了保证接口调用正常，请您确保调用前输入正确的资源ID）。

name

否

String

资源名称。

type

是

String

基础资源：cce、ecs、as。当deploy_mode为virtualmachine时可添加ecs、as，为container时可添加cce资源。

可选资源：rds、dcs、elb、cse等其他类型。

响应消息

表7 响应参数

参数

参数类型

描述

id

String

环境ID。

name

String

环境名称。

alias

String

环境别名。

description

String

环境描述。

project_id

String

项目ID。

enterprise_project_id

String

企业项目ID。

charge_mode

String

收费模式。

deploy_mode

String

环境类型。

  • virtualmachine：虚拟机。
  • container：Kubernetes。
  • mixed ：虚拟机和Kubernetes。

vpc_id

String

虚拟私有云ID。

base_resources

Array of objects

基础资源。请参考表8。

optional_resources

Array of objects

可选资源。请参考表8。

creator

String

创建人。

create_time

Integer

创建时间。

update_time

Integer

修改时间。
表8 schemas参数

参数

参数类型

描述

id

String

资源ID。

name

String

资源名称。

type

String

基础资源：cce、ecs、as。

可选资源：rds、dcs、elb、cse等其他类型。

请求示例

修改环境资源，添加名称为ecs-9876的ECS基础资源、专业版CSE可选资源，移除名称为test的ECS资源。

{
	"add_base_resources": [
		{
			"id": "ed2f3420-7031-4d93-b92b-e360cd4acf9e",
			"type": "ecs",
			"name": "ecs-9876"
		}
	],
	"add_optional_resources": [
		{
			"id": "default",
			"type": "cse",
			"name": "Cloud Service Engine"
		}
	],
	"remove_resources": [
		{
			"id": "523498f1-36c4-11eb-ae36-0255ac1000c2",
			"name": "test",
			"type": "ecs"
		}
	]
}

响应示例

{
	"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": "virtualmachine",
	"vpc_id": "29d55020-ae0e-4a18-871c-93e6976ee7bd",
	"base_resources": [
		{
			"id": "ed2f3420-7031-4d93-b92b-e360cd4acf9e",
			"type": "ecs",
			"name": "ecs-9876"
		}
	],
	"optional_resources": [
		{
			"id": "9963306a-791e-468c-9306-cf80a9d00298",
			"type": "elb",
			"name": "elb-2dd2"
		},
		{
			"id": "default",
			"type": "cse",
			"name": "Cloud Service Engine"
		}
	],
	"creator": "ss-test",
	"create_time": 1610418873730,
	"update_time": 1610420992462
}

状态码

表9 状态码说明

HTTP状态码

描述

200

操作成功。

400

错误的请求。

404

请求对象不存在。

500

内部错误。

错误码

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

父主题： 环境