全部产品
云市场

环境管理

更新时间:2019-01-21 14:28:34

什么是环境管理

目前每个 API 分组有三个环境:测试、预发和线上。其中测试环境和预发环境为测试人员测试或调试 API 时使用的环境,线上环境主要为 API 用户使用的环境。

通过 API 分组的 环境管理 设置环境变量参数,为 API 分组的测试、预发、线上环境分别定义一个变量。环境变量参数,即为每个环境自定义的公共常量参数。当调用 API 时,可以将环境参数放置于请求的任意位置,传递给后端服务。API 网关将适配您请求中的环境参数信息来区分请求环境。

多环境

环境变量参数配置方法

首先,在 API 分组的 环境管理 中,为每个环境创建变量。然后,在 API 定义 中配置已创建的环境变量。

创建环境变量

要实现通过环境变量参数区分请求环境,您需为测试、预发、线上三个环境,分别新增一个变量。

目前,每个环境允许配置最多 50 个环境变量。

  1. 登录 API 网关控制台

  2. 单击 分组管理 > 环境管理

    环境配置

  3. 选择要增加变量的环境:线上、预发、或测试,再单击 新增变量

    您需为不同的环境逐个新增一个变量。

  4. 填写变量名称和值,再单击 新增

    • Name:自行定义变量名称,但需 保持三个环境中的对应的变量名称相同

      如果您有多个 API,建议 Name 标识有实际意义,以便后续查询。

    • Value:变量的值。

      如果以函数计算为 API 网关的后端服务,Value 值请填写您在函数计算服务中创建的服务名称或者函数名称。您需填写正确的服务名称或者函数名称,否则可能造成无法调用 API。

      以函数计算服务为例。

      一个函数服务,测试、预发、线上环境的名称分别为:TestServiceD、PreServiceD、ServiceD。(函数计算中环境变量设置,请参见函数计算文档 环境变量。)为 API 分组的测试、预发、线上环境分别定义一个的变量。变量可命名为 Service,并填写相应的服务名称作为 Value。

      定义环境变量

您还可以以函数名称录入名为 Function 的环境变量,并为三个环境分别设置变量。

在 API 定义里配置环境变量

API 定义时,在 请求Path入参定义定义 API 后端服务等部分加入变量。

表示方法:#变量名#。如,#Service#、#Function#。

如,在定义以函数计算作为 API 网关后端服务时,将服务名称和函数名称定义为已创建的变量。

定义 API

调用多环境 API

API 发布后,便可发起 API 调用。

线上环境调用

直接发起 API 调用,即调用线上环境。

预发环境调用

调用预发环境的 API, 则在调用 API 时,在 Header 中增加入参 X-Ca-Stage: PRE, 即可访问预发环境的 API。

测试环境调用

调用测试环境的 API,则在调用 API 时,在 Header 中增加入参 X-Ca-Stage: TEST, 即可访问测试环境的 API。