检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建环境和环境变量 操作场景 API可以同时提供给不同的环境调用,如生产、测试或开发。RELEASE是默认存在的环境,无需创建。且API网关提供环境变量功能,通过创建环境变量,实现在不同的环境定义不同的API调用路径。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上
配置API的发布环境和环境变量(可选) 环境是指API的受限使用范围,API只有在发布到环境后,才能被调用。API可以被发布到不同的自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建的一种变量,该变量固定在环境上
环境变量管理 对象模型 新建变量 删除变量 查看变量详情 查询变量列表 父主题: 共享版API(仅存量用户使用)
表2 参数说明 名称 是否必选 类型 说明 id 是 String 环境变量的编号 请求消息 无 响应消息 表3 参数说明 参数 类型 说明 id String 环境变量的编号 env_id String 环境编号 group_id String API分组编号 variable_name
专享版-环境变量管理 新建变量 删除变量 查看变量详情 查询变量列表 修改变量 父主题: 专享版API(V2)
环境变量管理(待下线) 对象模型 新建变量 删除变量 查看变量详情 查询变量列表 父主题: 专享版API(V1)(待下线)
查看变量详情 功能介绍 查看指定的环境变量的详情。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/env-variables/{env_variable_id} 表1 路径参数 参数
可以使用这些变量。 环境变量的变量名称必须保持唯一,即一个分组在同一个环境上不能有两个同名的变量。 环境变量区分大小写,即变量ABC与变量abc是两个不同的变量。 设置了环境变量后,使用到该变量的API的调试功能将不可使用。 定义了环境变量后,使用到环境变量的地方应该以对称的#标
量。 环境变量的变量名称必须保持唯一,即一个分组在同一个环境上不能有两个同名的变量 环境变量区分大小写,即变量ABC与变量abc是两个不同的变量 设置了环境变量后,使用到该变量的API的调试功能将不可使用。 定义了环境变量后,使用到环境变量的地方应该以对称的#标识环境变量,当AP
量。 环境变量的变量名称必须保持唯一,即一个分组在同一个环境上不能有两个同名的变量 环境变量区分大小写,即变量ABC与变量abc是两个不同的变量 设置了环境变量后,使用到该变量的API的调试功能将不可使用。 定义了环境变量后,使用到环境变量的地方应该以对称的#标识环境变量,当AP
修改变量 功能介绍 修改环境变量。环境变量引用位置为api的后端服务地址时,修改对应环境变量会将使用该变量的所有api重新发布。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/env
String 实例ID,可从API网关控制台的专享版实例信息中获取。 id 是 String 环境变量的编号 请求消息 无 响应消息 表3 参数说明 参数 类型 说明 id String 环境变量的编号 env_id String 环境编号 group_id String API分组编号
variables 字典数据类型 本次返回的环境变量列表 total Integer 满足条件的环境变量总数 size Integer 本次返回的列表长度 表4 variables参数说明 参数 类型 说明 id String 环境变量编号 env_id String 环境编号 group_id
查询变量列表 功能介绍 查询分组下的所有环境变量的列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/env-variables 表1 路径参数 参数 是否必选 参数类型 描述 project_id
variables 字典数据类型 本次返回的环境变量列表 total Integer 满足条件的环境变量总数 size Integer 本次返回的列表长度 表4 variables参数说明 参数 类型 说明 id String 环境变量编号 env_id String 环境编号 group_id
删除变量 功能介绍 删除指定的环境变量。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/env-variables/{id} URI中的参数说明如下表所示。 表2 参数说明
删除变量 功能介绍 删除指定的环境变量。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1/{project_id}/apigw/instances/{instance_id}/env-variables/{id}
对象模型 本节介绍环境变量的对象模型,如下表所示: “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 环境变量对象模型 参数 类型 说明 操作类型 是否必选
删除变量 功能介绍 删除指定的环境变量。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/env-variables/{env_variable_id} 表1 路径参数 参数 是否必选
对象模型 本节介绍环境变量的对象模型,如下表所示: “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 环境变量对象模型 参数 类型 说明 操作类型 是否必选