更新时间:2022-04-21 GMT+08:00
分享

创建环境和环境变量

操作场景

API可以同时提供给不同的环境调用,如生产、测试或开发。RELEASE是默认存在的环境,无需创建。且API网关提供环境变量功能,通过创建环境变量,实现在不同的环境定义不同的API调用路径。

环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。

当创建API时定义了变量标识,则需要在环境中添加变量。例如创建API时定义了变量名为“Path”,在环境1中创建了变量名“Path”,变量值“/Stage/test”,则API在发布到环境1时,使用“/Stage/test”代替“Path”,API调用者在环境1中调用此API时,后端服务请求Path为“/Stage/test”。在环境2中创建了变量名“Path”,变量值“/Stage/AA”,则API在发布到环境2时,使用“/Stage/AA”代替“Path”,API调用者在环境2中调用此API时,后端服务请求Path为“/Stage/AA”。

图1 环境变量示意图

每个分组在任意一个环境中,最多创建50个变量。

前提条件

创建API分组

创建环境

  1. 登录管理控制台。
  2. 在管理控制台左上角单击,选择区域。
  3. 单击管理控制台左上角,然后单击“API网关 APIG”。
  4. 在左侧选择您的API版本,单击并进入到对应版本的API开发与调用管理页面。

    • “共享版”指直接创建并管理API,如涉及到费用,以API调用次数计费。
    • “专享版”指在API专享版实例中创建并管理API,如涉及到费用,按实例运行时间计费。

  5. 选择“开放API > 环境管理”,进入到环境管理信息页面。
  6. 单击“创建环境”,弹出“创建环境”对话框。填写如表1所示信息。

    图2 创建环境
    表1 环境信息

    信息项

    描述

    环境名称

    API环境名称。

    描述

    环境描述信息。

  7. 单击“确定”,创建环境。

    创建环境成功后,在“环境管理”页面的列表中显示新创建的环境。

访问环境

通过RESTful API可以访问API默认的RELEASE环境,如果访问其他环境,需要在请求头中添加X-Stage头,内容为环境名。例如访问名为“DEVELOP”的环境,则添加“X-Stage:DEVELOP”。

API网关管理控制台的“调试”功能,固定为调试环境,不支持携带环境变量调试。

创建环境变量

  1. 登录管理控制台。
  2. 在管理控制台左上角单击,选择区域。
  3. 单击管理控制台左上角,然后单击“API网关 APIG”。
  4. 在左侧选择您的API版本,单击并进入到对应版本的API开发与调用管理页面。

    • “共享版”指直接创建并管理API,如涉及到费用,以API调用次数计费。
    • “专享版”指在API专享版实例中创建并管理API,如涉及到费用,按实例运行时间计费。

  5. 选择“开放API > API分组”,进入到API分组信息页面。
  6. 通过以下任意一种方式,进入“变量管理”页签。

    • 单击待操作的分组名称,进入分组详细信息页面。单击“变量管理”。
    • 在待创建环境变量的分组所在行,单击“更多 > 变量管理”。

  7. 在“环境”中选择待添加变量的环境名称,单击“添加变量”,弹出“新增变量”对话框。
  8. 填写如表2所示信息。

    图3 新增变量
    表2 新增变量

    信息项

    描述

    变量名称

    变量的名称,必须与创建API时定义的变量标识完全相同。

    变量值

    变量路径。

  9. 单击“确定”,完成变量的添加。

    如果不再需要此变量时,在变量所在行单击“删除”。

    在实际发送API请求中,环境变量名称与变量值会明文传递,请勿携带隐私信息。

后续操作

创建完环境和环境变量后,您可以将API发布到环境,以便API调用者调用。

使用API方式创建环境

您还可以使用API的方式创建环境和变量,具体操作请查看以下链接。

创建环境

新建变量

分享:

    相关文档

    相关产品

关闭导读