Obtaining All Environments

Function

This API is used to obtain all created environments.

URI

GET /v2/{project_id}/cas/environments

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

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Number of records to be displayed. The value is 1000 or ranges from 0 to 100. If the specified value is not within the range, value 10 is assigned. In the non-pagination scenario, the value is 1000. In the pagination scenario, the value ranges from 0 to 100.
offset	No	Integer	Offset, which indicates the result after the Nth data record is queried.
order_by	No	String	Sorting field. By default, query results are sorted by creation time. Enumerated values: create_time, name, and update_time. If the transferred value is not within the supported enumerated value range, the default sorting field is used.
order	No	String	Sorting order. desc (default) asc

Request

**Table 3** 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.

Response

**Table 4** Response parameters
Parameter	Type	Description
count	Integer	Total number of environments.
environments	Array of objects	Environment parameters. See Table 5.

**Table 5** environments 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.
deploy_mode	String	Environment type. virtualmachine container: Kubernetes mixed: VM and Kubernetes
vpc_id	String	VPC ID.
base_resources	Array of objects	Basic resources. See Table 6.
optional_resources	Array of objects	Optional resources. See Table 6.
creator	String	Creator.
create_time	Integer	Creation time.
update_time	Integer	Update time.

**Table 6** resources parameters
Parameter	Type	Description
id	String	Resource ID.
name	String	Resource name.
type	String	Basic resources: cce, as, and ecs. Optional resources: rds, dcs, elb, cse, and other services.

Example Request

None

Example Response

{
	"environments": [
		{
			"id": "00078e9d-a61c-476e-ac63-a10c9cb2638e",
			"name": "development-env",
			"alias": null,
			"description": "",
			"project_id": "e7d2e9c589e5445e808a8ff0d1235aca",
			"enterprise_project_id": "0",
			"charge_mode": "provided",
                        "deploy_mode": "container",
			"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
		}
	],
	"count": 1
}