获取所有环境

功能介绍

此API用来获取所有已经创建的环境。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/cas/environments

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	租户项目ID。获取方法，请参考获取项目ID。

表2 查询参数
参数	是否必选	参数类型	描述
limit	否	Integer	指定个数，取值[0, 100]或者1000，指定的值不在该范围内的话相当于赋值为10。默认1000，用于不分页的场景。分页的场景取值请用[0, 100]。
offset	否	Integer	指定偏移量，表示查询第n条数据后的结果。
order_by	否	String	排序字段，默认按创建时间排序。排序字段支持枚举值：create_time、name、update_time。传的值不在支持的枚举值范围内的话按默认排序字段排序。
order	否	String	排序方式。 desc，降序排序，默认为desc。 asc，升序排序。

请求消息

表3 请求Header参数
参数	是否必选	参数类型	描述
Content-Type	是	String	消息体的类型（格式），默认取值为“application/json;charset=utf8”。
X-Auth-Token	是	String	调用接口的认证方式分为Token和AK/SK两种。如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。

响应消息

表4 响应参数
参数	参数类型	描述
count	Integer	环境总数。
environments	Array of objects	环境参数，请参考表5。

表5 environments
参数	参数类型	描述
id	String	环境ID。
name	String	环境名称。
alias	String	环境别名。
description	String	环境描述。
project_id	String	项目ID。
enterprise_project_id	String	企业项目ID。
charge_mode	String	收费模式。
deploy_mode	String	环境类型。 virtualmachine：虚拟机。 container：Kubernetes。 mixed ：虚拟机和Kubernetes。
vpc_id	String	虚拟私有云ID。
base_resources	Array of objects	基础资源，请参考表6。
optional_resources	Array of objects	可选资源，请参考表6。
creator	String	创建人。
create_time	Integer	创建时间。
update_time	Integer	修改时间。

表6 resources
参数	参数类型	描述
id	String	资源ID。
name	String	资源名称。
type	String	基础资源：cce、ecs、as。可选资源：rds、dcs、elb、cse等其他类型。

请求示例

无

响应示例

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