# 获取环境列表 - ListEnvironments #### 功能介绍 获取环境列表。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CAE/doc?api=ListEnvironments)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-cae/cae_06_0016.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v1/{project_id}/cae/environments 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取项目ID请参见[获取项目ID](https://support.huaweicloud.com/api-cae/cae_06_0021.html)。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。 - 获取Token，请参考《[统一身份认证服务API参考](https://support.huaweicloud.com/api-iam/iam_30_0001.html)》的"获取用户Token"章节。 - 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 | | X-Enterprise-Project-ID | 否 | String | 企业项目ID。 - 创建环境时，环境会绑定企业项目ID。 - 最大长度36字节，带"-"连字符的UUID格式，或者是字符串"0"。 - 该字段不传（或传为字符串"0"）时，则查询默认企业项目下的资源。 说明： 关于企业项目ID的获取及企业项目特性的详细信息，请参见《[企业管理服务用户指南](https://support.huaweicloud.com/usermanual-em/zh-cn_topic_0126101490.html)》。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | api_version | String | API版本，固定值"v1"，该值不可修改。 | | kind | String | API类型，固定值"Environment"，该值不可修改。 | | items | Array of [EnvironmentItem] objects | 环境列表。 | 表4EnvironmentItem | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 环境ID。 | | name | String | 环境名称。 | | job_id | String | 任务ID。 | | status | String | 环境状态。 - creating：创建中 - create_failed：创建失败 - finish：环境正常 - deleting：删除中 - freeze：冻结 - police_freeze：公安冻结 - delete_failed：删除失败 - wakening：唤醒中 - wakeup_failed：唤醒失败 | | annotations | Map\ | 环境附加属性。 - cluster_id：CCE集群ID。 - enterprise_project_id：企业项目ID。 - env_category: 环境种类，当前支持v1、v2，在授权云存储时，v1、v2种类环境有所不同。 - group_name：主环境绑定的SWR组织名称。 - inbound_eip_addr：负载均衡绑定EIP地址。 - namespace：CCE集群命名空间。 - public_elb_id：ELB ID，主环境绑定的负载均衡ID。 - type：环境类型，当前仅支持exclusive类型。 - vpc_id：主环境绑定的VPC ID。 - subnet_id：主环境绑定的入网子网ID。 - egress_subnet_id：主环境绑定的出网子网ID。 - elb_id：主环境绑定的独享型ELB。 - runtime_platform: 主环境绑定运行时平台类型。 | | created_at | String | 创建时间。 | | updated_at | String | 更新时间。 | #### 请求示例 获取环境列表。 ``` GET https://{endpoint}/v1/{project_id}/cae/environments ``` #### 响应示例 **状态码：200** 请求成功。 ``` { "api_version" : "v1", "kind" : "Environment", "items" : [ { "id" : "5d3d1e90-2f5d-4ef1-958b-3fc1ed0b0898", "name" : "test", "version" : "1.2.0", "job_id" : "15cbf4ff-e6a8-4504-a5e0-574b9c21493a", "status" : "finish", "annotations" : { "cluster_id" : "2177808d-a78e-11ed-be73-0255ac100b0a", "enterprise_project_id" : "0", "env_category" : "v2", "group_name" : "xxx", "inbound_eip_addr" : "100.xx.xx.xxx", "namespace" : "79c4xxxf5f3a4xxxda92601xxx64b1e8c-test", "public_elb_id" : "da9e107e-bd25-412f-9546-563ed11ae34c", "type" : "exclusive", "vpc_id" : "09902850-9454-4715-9764-018f0c3701fd", "subnet_id" : "b8ed83e8-da73-440e-95ca-0f16a328c987", "egress_subnet_id" : "b8ed83e8-da73-440e-95ca-0f16a328c987", "elb_id" : "fffdb681-4b5b-4e17-8aad-ee128ab187c7", "runtime_platform" : "cce-share" }, "created_at" : "2023-02-08T08:49:34.000737Z", "updated_at" : "2023-02-08T08:49:34.000737Z" } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-cae/ErrorCode.html)。