Modifying an Environment Based on the Environment ID

Function

This API is used to modify an environment based on the environment ID.

URI

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

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant's project ID. See Obtaining a Project ID.
environment_id	Yes	String	Environment ID. See Obtaining All Environments.

Request

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type or format.
X-Auth-Token	Yes	String	API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token. For details about how to obtain a token, see Obtaining a User Token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	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. Letters are case insensitive.
description	No	String	Environment description. The value can contain up to 128 characters.
labels	No	Array of objects	Label. You can use TMS to filter resources by labels. See Table 4.

**Table 4** labels parameters
Parameter	Mandatory	Type	Description
key	Yes	String	Label name.
value	Yes	String	Label value.

Response

**Table 5** Response parameters
Parameter	Type	Description
id	String	Environment ID.
name	String	Environment name.
description	String	Environment description.
project_id	String	Project ID.
enterprise_project_id	String	Enterprise project ID.
deploy_mode	String	Environment type.
vpc_id	String	VPC ID.
creator	String	Creator.
create_time	Integer	Creation time.
update_time	Integer	Update time.
labels	Array of objects	Label. You can use TMS to filter resources by labels. See Table 6.
resources	Array of objects	Resource. See Table 7.

**Table 6** labels parameters
Parameter	Type	Description
key	String	Label name.
value	String	Label value.

**Table 7** resources parameters
Parameter	Type	Description
id	String	Resource ID.
name	String	Resource name.
type	String	Resource type. vpc eip elb cce ecs as cse dcs rds

Example Request

Modify the environment name to development-env, leave the description blank, and add a label whose key-value pair is "test": "value" to the environment.

{
	"name": "development-env",
	"description": "",
        "labels": [
            {
                "key": "test",
                "value": "value"
            }
        ]
}

Example Response

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