
# 配置API的发布环境和环境变量（可选）
**环境**是指API的受限使用范围，API只有在发布到环境后，才能被调用。API可以被发布到不同的自定义环境中，如开发环境、测试环境等。RELEASE是系统默认的发布环境，也是正式发布环境。
**环境变量**是指在环境上创建的一种变量，该变量固定在环境上。如果API的后端服务信息中定义了环境变量，则需要在环境中添加对应的变量。通过环境变量，可实现同一个API，在不同环境中调用不同的后端服务。
例如创建API时，后端服务请求Path中定义了变量"Path"。在环境1中创建了变量"Path"，变量值"/Stage/test"，则API在发布到环境1时，使用"/Stage/test"代替"Path"，在环境1中调用此API时，后端服务请求Path为"/Stage/test"。在环境2中创建了变量"Path"，变量值"/Stage/AA"，则API在发布到环境2时，使用"/Stage/AA"代替"Path"，在环境2中调用此API时，后端服务请求Path为"/Stage/AA"。
图1环境变量示意图   
![](https://support.huaweicloud.com/usermanual-apig/zh-cn_image_0000001178542512.png "点击放大")
#### 创建环境
1. 进入[API网关控制台](https://console.huaweicloud.com/apig2/#/overview)页面。
2. 根据实际业务在左侧导航栏上方选择实例。

3. 在左侧导航栏选择"API管理 \> API策略"。
4. 单击"环境管理"页签。

5. 单击"创建环境"，根据下表参数说明，填写环境信息。 
   表1环境信息 
   | 参数   | 说明                                        |
   |:---|:---|
   | 环境名称 | API环境名称。支持英文，数字，下划线，且只能以英文开头，长度为3\~64个字符。 |
   | 描述   | 环境描述信息。长度为1\~255个字符。                      |
      
   
   
6. 单击"确定"，创建环境。 
   - 创建环境成功后，在"环境管理"页面的列表中显示新创建的环境。
   
   - 如果需要删除环境，在"操作"列单击"删除"即可。 RELEASE系统环境不能删除；如果环境上存在已发布的API，需要先下线API才能删除环境。删除后将无法恢复，请谨慎操作。
     
   
   - **用户调用开放的API时，默认是调用RELEASE环境的API。如果要访问其他环境上的API，需要在API请求中添加Header参数"X-Stage"，参数值为环境名。例如要访问环境名为"Develop"上的API，则在API请求的Header参数中添加"X-Stage: Develop"。**
   
   
   
   
 
#### 创建环境变量
1. 进入[API网关控制台](https://console.huaweicloud.com/apig2/#/overview)页面。

2. 根据实际业务在左侧导航栏上方选择实例。

3. 在左侧导航栏选择"API管理 \> API分组"。
4. 单击分组名称，进入"分组信息"页面。
5. 在"环境变量"区域，选择环境。如果未创建环境，可单击"创建环境"创建。
6. 单击"添加环境变量"，根据下表参数说明，填写变量信息。 
   - **在实际发送API请求中，环境变量名称与变量值会明文传递，请勿携带隐私信息。**
   
   - **API网关管理控制台的"调试"功能，固定为调试环境，不支持携带环境变量调试。**
   
   
   表2新增变量 
   | 参数   | 说明                                                                                                                                               |
   |:---|:---|
   | 变量名称 | 变量的名称，必须与创建API时定义的变量标识完全相同。在API定义中等于#Name值#部分（区分大小写），发布到环境里的API被变量值替换。 支持英文、数字、英文格式的下划线、中划线，必须以英文字母开头，长度为3\~32个字符。 |
   | 变量值  | 环境变量的值，支持英文、数字、英文格式的下划线、中划线、斜线、点、冒号，长度为1\~255个字符。                                                                                                |
      
   
   
7. 单击"确定"，创建完成。 
   - 创建环境变量成功后，在环境变量列表中显示新创建的变量。
   
   - 如果需要删除环境变量，在"操作"列单击"删除"即可。删除后将无法恢复，请谨慎操作。
   
   - **如果环境变量被修改，需要重新发布API，否则新变量将不生效。**
   
   
   
   
 
#### 相关文档
- 您可以将API[发布到环境](https://support.huaweicloud.com/usermanual-apig/apig_03_0014.html)，以便API调用者调用。
- 如果您希望通过API创建环境或环境变量，请参考[创建环境](https://support.huaweicloud.com/api-apig/CreateEnvironmentV2.html)或[新建变量](https://support.huaweicloud.com/api-apig/CreateEnvironmentVariableV2.html)。
 
