# 获取所有环境 - ObtainAllEnvironments
#### 功能介绍
此API用于获取所有已经创建的环境。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ServiceStage/doc?api=ShowEnvironments&version=v3)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-servicestage/servicestage_06_0183.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                           | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名                    | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | servicestage:environment:list | list | -           | -   | servicestage:app:list | -      |
     
  
 
#### URI
GET /v3/{project_id}/cas/environments
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|:---|:---|:---|:---|
| project_id | 是    | String | **参数解释：** 租户项目ID。获取方法，请参考[获取项目ID](https://support.huaweicloud.com/api-servicestage/servicestage_06_0164.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
   
表2查询参数 
| 参数                    | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|:---|:---|:---|:---|
| limit                 | 否    | Integer | **参数解释：** 查询个数。 **约束限制：** 不涉及 **取值范围：** 1\~100 **默认取值：** 10                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| offset                | 否    | Integer | **参数解释：** 查询偏移量，表示查询第n条数据后的结果。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 0                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| order_by              | 否    | String  | **参数解释：** 排序字段。 **约束限制：** 不涉及 **取值范围：** 排序字段支持如下枚举值： - create_time：环境创建时间。  - name：环境名称。  - update_time：环境修改时间。   传值不在支持的枚举值范围内按默认排序字段排序。 **默认取值：** create_time |
| order                 | 否    | String  | **参数解释：** 排序方式。 **约束限制：** 不涉及 **取值范围：** - desc：降序排序。  - asc：升序排序。   **默认取值：** desc                                                                                                                                                                                                                                                                                                                                                                                  |
| name                  | 否    | String  | **参数解释：** 指定环境名称，查询对应环境名称的环境信息。 **取值范围：** 不涉及 **默认取值：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| environment_id        | 否    | String  | **参数解释：** 指定环境ID，查询对应环境ID的环境信息。 **取值范围：** 不涉及 **默认取值：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| enterprise_project_id | 否    | String  | **参数解释：** 指定企业项目ID，查询对应企业项目ID的环境信息。 **取值范围：** 不涉及 **默认取值：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
   
#### 请求消息
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|:---|:---|:---|:---|
| Content-Type | 是    | String | **参数解释：** 消息体的类型（格式）。 **约束限制：** 不涉及 **取值范围：** application/json;charset=utf8 **默认取值：** 不涉及                                                                                                                      |
| X-Auth-Token | 是    | String | **参数解释：** 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考[认证鉴权](https://support.huaweicloud.com/api-servicestage/servicestage_06_0010.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
   
#### 响应消息
表4响应参数 
| 参数           | 参数类型             | 描述                                                                                                                                                                                                                                                            |
|:---|:---|:---|
| count        | Integer          | **参数解释：** 环境总数。 **取值范围：** 不涉及 |
| environments | Array of objects | **参数解释：** 环境参数，请参考[表5]。                                                                               |
   
 表5environments 
| 参数                    | 参数类型             | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|:---|:---|:---|
| id                    | String           | **参数解释：** 环境ID。 **取值范围：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| name                  | String           | **参数解释：** 环境名称。 **取值范围：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| description           | String           | **参数解释：** 环境描述。 **取值范围：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| project_id            | String           | **参数解释：** 项目ID。 **取值范围：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| enterprise_project_id | String           | **参数解释：** 企业项目ID。 **取值范围：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| deploy_mode           | String           | **参数解释：** 环境类型。 **取值范围：** - virtualmachine：虚拟机。  - container：Kubernetes。  - mixed ：虚拟机+Kubernetes。                                                                                                                                        |
| vpc_id                | String           | **参数解释：** 虚拟私有云ID。 **取值范围：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| creator               | String           | **参数解释：** 环境创建人。 **取值范围：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| create_time           | Integer          | **参数解释：** 环境创建时间。 **取值范围：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| update_time           | Integer          | **参数解释：** 环境修改时间。 **取值范围：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| labels                | Array of objects | **参数解释：** 标签，可使用标签管理服务通过标签过滤资源，请参考[表6]。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| type                  | String           | **参数解释：** Kubernetes环境是否高可用类型。 **取值范围：** - normal：非高可用环境。  - high：高可用环境。                                                                                                                                                                                                                                                                                                                    |
| resource_create_mode  | String           | **参数解释：** 资源配置模式。 **取值范围：** - none：纳管资源。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| config_mode           | String           | **参数解释：** 配置模式。 **取值范围：** - ui：基于UI页面配置。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| env_status            | String           | **参数解释：** 获取的非实时环境资源状态。 **取值范围：** - REFRESHING：刷新中。  - UNKNOWN：未知。  - NORMAL：正常。  - PARTIALLY_NORMAL：部分正常。   |
   
 表6labels 
| 参数    | 参数类型   | 描述                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|
| key   | String | **参数解释：** 标签名称。 **取值范围：** 不涉及  |
| value | String | **参数解释：** 标签值。 **取值范围：** 不涉及 |
   
#### 请求示例
无
#### 响应示例
```
{
"environments": [
{
"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,
                        "labels": null
}
],
"count": 1
}
```
#### 状态码
| 状态码 | 描述       |
|:---|:---|
| 200 | 操作成功。    |
| 400 | 错误的请求。   |
| 404 | 请求对象不存在。 |
| 500 | 内部错误。    |
   
#### 错误码
请参考[ServiceStage错误码](https://support.huaweicloud.com/api-servicestage/servicestage_06_0162.html)。