Obtaining Environment Details Based on the Environment ID

Function

This API is used to obtain environment details based on the environment ID.

URI

GET /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.

Response

**Table 3** 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. virtualmachine container: Kubernetes mixed: VM and Kubernetes.
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 4.
resources	Array of objects	Resource. See Table 5.
type	String	Whether the Kubernetes environment is of the HA type. normal: non-HA environment. high: HA environment.
resource_create_mode	String	Resource configuration mode. none: resource management.
config_mode	String	Configuration mode. ui
env_status	String	Environment resource status (non-real-time status). REFRESHING UNKNOWN NORMAL PARTIALLY_NORMAL
configuration	Object	Environment variable of the environment. See Table 7.

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

**Table 5** 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 customServer gaussdb dms_rocketmq css_es: Elasticsearch custom_k8s: custom Kubernetes cluster
core	String	Number of cores of the custom server. This parameter is returned when the resource type is customServer.
gib	String	Memory of the custom server, in Gib. This parameter is returned when the resource type is customServer.
parameters	Map<String, String>	Resource parameters. See Table 6.

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

**Table 7** configuration
Parameter	Type	Description
resource_envs	Array of objects	Resource variable bound to the environment. See Table 8.
envs	Array of objects	Environment variable of the environment. See Table 9.

**Table 8** 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 9.

**Table 9** 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

None

Example Response

{
    "id": "ea011e01-2eb5-453f-87bf-874e4a855abe", 
    "name": "dev-env",
    "description": "develop environment", 
    "project_id": "bf8523d898b64e4eb956e3be3555ca16", 
    "enterprise_project_id": "0", 
    "deploy_mode": "virtualmachine",
    "vpc_id": "234241234124xxvasf2342xxxxxxxxxxx", 
    "resources": [
        {
            "id": "329b135e-7b31-4ea6-afb9-b69017bd0a80",
            "type": "ecs",
            "name": "ecs-test"
        }
    ], 
    "creator": "ss-test", 
    "create_time": 1578984198394, 
    "update_time": 1578984198394,
    "labels": null
}