Updated on 2022-08-15 GMT+08:00

Modifying Environment Resources

Function

This API is used to modify environment resources.

URI

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

Table 1 Path parameters

Parameter

Type

Mandatory

Description

project_id

String

Yes

Tenant's project ID.

environment_id

String

Yes

Environment ID.

Request

Table 2 Request parameters

Parameter

Type

Mandatory

Description

add_base_resources

Array of objects

No

Basic resources to be added. See Table 3.

add_optional_resources

Array of objects

No

Optional resources to be added. See Table 4.

remove_resources

Array of objects

No

Resources to be removed. See Table 5.

Table 3 add_base_resources parameters

Parameter

Type

Mandatory

Description

id

String

Yes

Resource ID.

name

String

No

Resource name.

type

String

Yes

Basic resources: cce, and ecs.

Table 4 add_optional_resources parameters

Parameter

Type

Mandatory

Description

id

String

Yes

Resource ID.

name

String

No

Resource name.

type

String

Yes

Optional resources: dcs, elb, and other services.

Table 5 remove_resources parameters

Parameter

Type

Mandatory

Description

id

String

Yes

Resource ID.

type

String

Yes

Basic resources: cce, and ecs.

Optional resources: dcs, elb, and other services.

Response

Table 6 Parameters

Parameter

Type

Description

id

String

Environment ID.

name

String

Environment name.

alias

String

Environment alias.

description

String

Environment description.

project_id

String

Project ID.

enterprise_project_id

String

Enterprise project ID.

charge_mode

String

Fixed value: provided.

vpc_id

String

VPC ID.

base_resources

Array of objects

Basic resources. See Table 7.

optional_resources

Array of objects

Optional resources. See Table 7.

creator

String

Creator.

create_time

Integer

Creation time.

update_time

Integer

Update time.

Table 7 schemas parameters

Parameter

Type

Description

id

String

Resource ID.

name

String

Resource name.

type

String

Basic resources: cce, and ecs.

Optional resources: dcs, elb, and other services.

Example

Example request

{
	"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",
			"type": "cce"
		}
	]
}

Example response

{
	"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",
	"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
}

Status Code

Table 8 Status codes

Status Code

Description

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

Error Code

Error code must be in the format of SVCSTG.00100.[Error_ID]. Example: SVCSTG.00100400. See Error Codes of Application Management APIs.