Updated on 2023-06-25 GMT+08:00

Creating an Environment

Function

An environment is a collection of compute, storage, and network resources used for deploying and running an application. ServiceStage enables you to add multiple Elastic Load Balance (ELB) and Distributed Cache Service (DCS) instances to Cloud Container Engine (CCE) clusters in the same Virtual Private Cloud (VPC) to set up an environment, such as the development environment, test environment, production-like environment, and production environment. The resources within an environment can be networked together. Managing resources and deploying services by environment simplifies O&M.

This API is used to create an environment.

URI

POST /v2/{project_id}/cas/environments

Table 1 Path parameters

Parameter

Type

Mandatory

Description

project_id

String

Yes

Tenant's project ID.

Request

Table 2 Request parameters

Parameter

Type

Mandatory

Description

name

String

Yes

Environment name.

The value contains 2 to 64 characters consisting of letters, digits, hyphens (-), and underscores (_). It starts with a letter and ends with a letter or digit.

alias

String

No

Environment alias.

The value can contain up to 64 characters.

description

String

No

Environment description.

The value can contain up to 128 characters.

enterprise_project_id

String

No

Enterprise project ID.

charge_mode

String

No

Fixed value: provided.

vpc_id

String

Yes

VPC ID.

base_resources

Array of objects

Yes

Basic resources. See Table 3.

optional_resources

Array of objects

No

Optional resources. See Table 3.

Table 3 resource parameters

Parameter

Type

Mandatory

Description

id

String

Yes

Resource ID.

name

String

No

Resource name.

type

String

Yes

Basic resources: cce, and ecs.

Optional resources: dcs, elb, and other services.

Response

Table 4 Response 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

Billing mode.

vpc_id

String

VPC ID.

base_resources

Array of objects

Basic resources. See Table 5.

optional_resources

Array of objects

Optional resources. See Table 5.

creator

String

Creator.

create_time

Integer

Creation time.

update_time

Integer

Update time.

Table 5 resource

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

{
	"name": "development-env",
	"description": "",
	"charge_mode": "provided",
	"vpc_id": "29d55020-ae0e-4a18-871c-93e6976ee7bd",
	"base_resources": [
		{
			"id": "523498f1-36c4-11eb-ae36-0255ac1000c2",
			"type": "cce",
			"name": "cce-test"
		}
	],
	"optional_resources": [
		{
			"id": "9963306a-791e-468c-9306-cf80a9d00298",
			"type": "elb",
			"name": "elb-2dd2"
		}
	]
}

Example response

{
	"id": "00078e9d-a61c-476e-ac63-a10c9cb2638e",
	"name": "development-env",
	"alias": null,
	"description": "",
	"project_id": "e7d2e9c589e5445e808a8ff0d1235aca",
	"enterprise_project_id": "0",
	"charge_mode": "provided",
	"vpc_id": "29d55020-ae0e-4a18-871c-93e6976ee7bd",
	"base_resources": [
		{
			"id": "523498f1-36c4-11eb-ae36-0255ac1000c2",
			"type": "cce",
			"name": "cce-test"
		}
	],
	"optional_resources": [
		{
			"id": "9963306a-791e-468c-9306-cf80a9d00298",
			"type": "elb",
			"name": "elb-2dd2"
		}
	],
	"creator": "ss-test",
	"create_time": 1610418873730,
	"update_time": 1610418873730
}

Status Code

Table 6 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.