配置api的发布环境和环境变量(可选)-j9九游会登录
环境是指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”。
创建环境
- 进入页面。
- 根据实际业务在左侧导航栏上方选择实例。
- 在左侧导航栏选择“api管理 > api策略”。
- 单击“环境管理”页签。
- 单击“创建环境”,根据下表参数说明,填写环境信息。
表1 环境信息 参数
说明
环境名称
api环境名称。支持英文,数字,下划线,且只能以英文开头,长度为3-64个字符。
描述
环境描述信息。长度为1-255个字符。
- 单击“确定”,创建环境。
- 创建环境成功后,在“环境管理”页面的列表中显示新创建的环境。
- 如果需要删除环境,在“操作”列单击“删除”即可。
release系统环境不能删除;如果环境上存在已发布的api,需要先下线api才能删除环境。删除后将无法恢复,请谨慎操作。
- 用户调用开放的api时,默认是调用release环境的api。如果要访问其他环境上的api,需要在api请求中添加header参数“x-stage”,参数值为环境名。例如要访问环境名为“develop”上的api,则在api请求的header参数中添加“x-stage: develop”。
创建环境变量
- 进入页面。
- 根据实际业务在左侧导航栏上方选择实例。
- 在左侧导航栏选择“api管理 > api分组”。
- 单击分组名称,进入“分组信息”页面。
- 在“环境变量”区域,选择环境。如果未创建环境,可单击“创建环境”创建。
- 单击“添加环境变量”,根据下表参数说明,填写变量信息。
- 在实际发送api请求中,环境变量名称与变量值会明文传递,请勿携带隐私信息。
- api网关管理控制台的“调试”功能,固定为调试环境,不支持携带环境变量调试。
表2 新增变量 参数
说明
变量名称
变量的名称,必须与创建api时定义的变量标识完全相同。在api定义中等于#name值#部分(区分大小写),发布到环境里的api被变量值替换。
支持英文、数字、英文格式的下划线、中划线,必须以英文字母开头,长度为3-32个字符。
变量值
环境变量的值,支持英文、数字、英文格式的下划线、中划线、斜线、点、冒号,长度为1~255个字符。
- 单击“确定”,创建完成。
- 创建环境变量成功后,在环境变量列表中显示新创建的变量。
- 如果需要删除环境变量,在“操作”列单击“删除”即可。删除后将无法恢复,请谨慎操作。
- 如果环境变量被修改,需要重新发布api,否则新变量将不生效。
相关文档
您可以将api,以便api调用者调用。
相关文档
意见反馈
文档内容是否对您有帮助?
如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨