检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
配置参数 配置参数提供了实例内组件的公共参数配置,通过修改配置参数,可以调整组件的相关功能。 约束与限制 修改实例配置参数会引起APIG业务中断,建议在无业务运行或业务低峰时修改配置参数。 操作步骤 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待配置参数的实例上,单击“查看控制台”或实例名称。
建,并且在函数的返回值中已设置context字段,字段中包含键值对。其中键值对的值只支持字符串、布尔、整型三种数值类型,键值对对应“系统参数-前端认证参数”策略条件的参数名称和条件值。 图1 自定义认证函数 已创建前端自定义认证。如果未创建,请参考自定义认证章节创建。 配置API前端
如为了区分普通调用与特殊调用,可以定义一个“策略后端”,通过调用前端自定义认证参数,为特殊调用方分配专用的后端服务。本方案以“系统参数-前端认证参数”为例,讲述用户如何通过设置“系统参数-前端认证参数”策略条件将API请求转发到指定的后端服务中。 约束与限制 添加策略后端前,前端
通过匹配系统参数-前端认证参数调用API的策略后端 方案概述 操作流程 实施步骤
件来源选择“系统参数-前端认证参数”,并完善参数名称、条件类型、条件值等,其中参数名称和条件值要与前端自定义认证函数返回值中context字段下的键值对一致。 调试API 调试API,观察是否成功调用到已添加的策略后端。 父主题: 通过匹配系统参数-前端认证参数调用API的策略后端
配置是否预处理策略。当编排规则为预处理时,将该编排规则生成的参数值作为临时参数,成为下一个编排规则的待编排参数。 参数名称 当“是否预处理策略”开关关闭或者“编排策略”选择“none_value”或“default”时需要配置。 填写编排后的参数名称。 参数类型 当“是否预处理策略”开关关闭或者“编
内置参数、前端认证参数和后端认证参数等,可以通过设置系统参数来实现。API网关向后端服务发送请求时,将系统参数添加到请求的指定位置,然后将请求发送给后端服务。 在“系统参数”下,单击“添加系统参数”,添加后端服务请求的系统参数。 表8 系统参数配置 参数 说明 系统参数类型 选择系统参数的类型。
如何切换调用环境? 默认调用“发布”环境的API。 如果您要调用其他环境的API,请添加请求消息头X-Stage,参数值填写环境名称。 父主题: API调用
表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 features Array of FeatureInfo objects 实例特性列表 表5 FeatureInfo 参数 参数类型 描述 id String
中获取的请求路径。 {Query}:查询参数,可选,格式为“参数名=参数取值”,例如limit=10,多个查询参数之间使用“&”隔开。需根据获取API的调用信息中获取的请求参数进行设置。 {Header}:请求头参数,格式为“参数名: 参数取值”,例如Content-Type:
enumerations String 参数枚举值 min_num Integer 参数最小值 参数类型为NUMBER时有效 max_num Integer 参数最大值 参数类型为NUMBER时有效 min_size Integer 参数最小长度 参数类型为STRING时有效 max_size
添加Header参数“host”。 {Path}:请求路径,需替换为获取API的调用信息中获取的请求路径。 {Query}:查询参数,可选,格式为“参数名=参数取值”,例如limit=10,多个查询参数之间使用“&”隔开。需根据获取API的调用信息中获取的请求参数进行设置。 {H
将支持简易认证的API绑定到已创建的应用。 发送请求时,增加请求头部参数“X-Apig-AppCode”,省略请求签名相关信息。 以Curl方式为例,增加头部参数名称:X-Apig-AppCode,参数值填已生成的AppCode。 curl -X GET "https://api
将支持简易认证的API绑定到已创建的凭据。 发送请求时,增加请求头部参数“X-Apig-AppCode”,省略请求签名相关信息。 以Curl方式为例,增加头部参数名称:X-Apig-AppCode,参数值填已生成的AppCode。 curl -X GET "https://api
0协议,在API网关控制台的“配置参数”页面中的“request_custom_config”参数下关闭HTTP/2协议即可。 Binary Format二进制格式 HTTP1.x以文本的形式传输,而HTTP2.0将所有传输信息分割为更小的消息和帧,并对它们采用二进制格式编码。相对于字符串
例如以下含有两个参数,其中第二个参数parm2的值为空。 parm1=value1&parm2= 按照字符代码以升序顺序对参数名进行排序。例如,以大写字母F开头的参数名排在以小写字母b开头的参数名之前。 以排序后的第一个参数名开始,构造规范查询字符串。 举例: 示例中包含两个可选参数:a、b
响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 throttles Array of ThrottlesInfo objects 本次查询到的流控策略列表 表5 ThrottlesInfo 参数 参数类型 描述
检查目标HTTP响应时,判断成功使用的HTTP响应码。 取值范围为100到599之前的任意整数值,支持如下三种格式: 多个值,如:200,201,202 一系列值,如:200-299 组合值,如:201,202,210-299 表5 后端实例列表 参数 是否必选 类型 说明 instance_name 是 String
检查目标HTTP响应时,判断成功使用的HTTP响应码。 取值范围为100到599之前的任意整数值,支持如下三种格式: 多个值,如:200,201,202 一系列值,如:200-299 组合值,如:201,202,210-299 表5 后端实例列表 参数 是否必选 类型 说明 instance_name 是 String
前端parameters参数说明 名称 是否必选 参数类型 说明 maximum 否 Float 参数为数值类型时,最大参数值 minimum 否 Float 参数为数值类型时,最小参数值 maxLength 否 Integer 参数为字符串类型时,参数的最大长度 minLength