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 (format). Default value: application/json;charset=utf8.
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 the token, see Authentication.

**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 sensitive.
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. Each environment can have a maximum of 20 labels.
enterprise_project_id	No	String	Enterprise project ID. If this parameter is not set, the default enterprise project is default and the ID is 0.
configuration	No	Object	Environment variable of the environment. See Table 5.

**Table 4** labels
Parameter	Mandatory	Type	Description
key	Yes	String	Label name. Labels are used to identify cloud resources. When you have multiple cloud resources of the same type, you can use labels to classify them based on usage, owner, or environment. The value contains 1 to 36 characters, including digits, letters, underscores (_), or hyphens (-).
value	Yes	String	Label value. The value contains 1 to 43 characters, including digits, letters, underscores (_), periods (.), or hyphens (-).

**Table 5** configuration
Parameter	Mandatory	Type	Description
resource_envs	No	Array of objects	Resource variable bound to the environment. See Table 6.
envs	No	Array of objects	Environment variable of the environment. See Table 7.

**Table 6** resource_env
Parameter	Mandatory	Type	Description
resource_id	Yes	String	ID of the resource associated with the resource variable bound to the environment.
resource_name	Yes	String	Name of the resource associated with the resource variable bound to the environment.
resource_type	Yes	String	Type of the resource associated with the resource variable bound to the environment.
envs	Yes	Array of objects	Resource variable bound to the environment. See Table 7.

**Table 7** config_env
Parameter	Mandatory	Type	Description
name	Yes	String	Key of the environment variable of the environment.
value	Yes	String	Value of the environment variable of the environment.

Response

**Table 8** 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	Environment creator.
create_time	Integer	Environment creation time.
update_time	Integer	Environment update time.
labels	Array of objects	Label. You can use TMS to filter resources by labels. See Table 9.
resources	Array of objects	Resource. See Table 10.
resource_create_mode	String	Resource configuration mode. none: resource management.
config_mode	String	Configuration mode. ui
configuration	Object	Environment variable of the environment. See Table 12.

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

**Table 10** resources
Parameter	Type	Description
id	String	Resource ID.
name	String	Resource name.
type	String	Resource type. vpc eip elb cce ecs as cse: ServiceComb engine nacos: registry/configuration center dcs rds subnet acl gaussdb dms_rocketmq customServer css_es: Elasticsearch custom_k8s: custom Kubernetes cluster
ip	String	IP address of the custom server when the resource type is set to customServer.
parameters	Map<String, String>	Resource parameters. See Table 11.
alias	String	Resource alias.

**Table 11** parameters
Parameter	Type	Description
kube_config	String	Kubernetes connection configuration file. This parameter is returned when the resource type is custom_k8s.

**Table 12** configuration
Parameter	Type	Description
resource_envs	Array of objects	Resource variable bound to the environment. See Table 13.
envs	Array of objects	Environment variable of the environment. See Table 14.

**Table 13** resource_env
Parameter	Type	Description
resource_id	String	ID of the resource associated with the resource variable bound to the environment.
resource_name	String	Name of the resource associated with the resource variable bound to the environment.
resource_type	String	Type of the resource associated with the resource variable bound to the environment.
envs	Array of objects	Resource variable bound to the environment. See Table 14.

**Table 14** config_env
Parameter	Type	Description
name	String	Key of the environment variable of the environment.
value	String	Value of the environment variable of the environment.

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