检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
后端服务部署在本地数据中心,且不能通过公网地址直接访问。 如果您使用专享版API网关,可为本地数据中心搭建一条与API网关(所绑定的华为云VPC)之间的专线。 本节针对后端服务部署在本地数据中心的场景,介绍使用API网关开放API的实践步骤。
list:列表中的值映射成另外的值。 range:范围中的值映射成另外的值。 hash:请求头的值经过哈希计算后直接映射为新的请求头。 hash_range:先用请求参数生成hash值,再用hash值进行range编排。
后端认证通过后,context中的user的值abc映射到后端服务Header位置的test参数中,并将其传递给API的后端服务。
API网关导入或导出的OAS对象,与API网关对象定义的映射关系。 请求参数类型与API网关参数类型差异。 API请求路径模板语法差异。 导入API时支持的API网关扩展字段。
前端认证通过后,context中的user的值abc映射到后端服务Header位置的test参数中。
x-apigateway-access-controls 含义:访问控制策略名称与关联策略映射。
客户端签名时将本地时间作为时间戳进行签名,如果本地时间与北京时间相差超过15min,网关会认为签名过期。 处理方法:将本地系统时间调整为与北京时间同步,确保时间的准确性,例如现在北京时间早上8:00,设置本地系统时间为北京时间早上8:00。 父主题: API认证
将调用API时传入的参数映射到后端服务对应的位置。 在“后端服务参数”右侧单击,通过以下任意一种方法配置后端服务参数。 单击“导入入参定义”,系统自动添加已创建的所有入参参数。 单击“添加后端参数映射”,按照需求添加您所需要的后端参数映射。
x-apigateway-ratelimits 含义:流控策略名称与关联策略映射。
orchestration_map 否 Array of OrchestrationMap objects 编排映射规则列表,列表长度范围为1-300。 编排映射规则的生效优先级与列表顺序保持一致,列表中靠前的配置匹配优先级较高。
origin 是 String 参数映射来源,支持REQUEST、CONSTANT。 description 否 String 参数含义描述。 父主题: APIG的API设计文件扩展定义
$context.authorizer.backend.property 后端自定义认证响应的context映射的指定键值对的字符串值 $context.error.message 当前网关错误响应的错误信息 $context.error.code 当前网关错误响应的错误码 $context.error.type
映射后端参数 添加系统参数,将函数返回的context信息传到后端。 验证 调用API,观察是否成功返回函数的context信息。 编写自定义认证函数 在函数工作流的控制台编写函数,自定义认证的代码编写指南参见创建用于前端自定义认证的函数配置API的前端自定义认证。
本示例以AK和SK保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。以Linux系统为例在本地将已获取的AK/SK设置为环境变量。 打开终端,输入以下命令打开环境变量配置文件。
最小长度:3 最大长度:64 orchestration_strategy String 编排策略,有以下几种策略类型: list:列表; hash:哈希; range:区间; hash_range: 哈希+区间; none_value: 空值映射; default: 默认值映射;
orchestration_map 否 Array of OrchestrationMap objects 编排映射规则列表,列表长度范围为1-300。 编排映射规则的生效优先级与列表顺序保持一致,列表中靠前的配置匹配优先级较高。
orchestration_map Array of OrchestrationMap objects 编排映射规则列表,列表长度范围为1-300。 编排映射规则的生效优先级与列表顺序保持一致,列表中靠前的配置匹配优先级较高。
配置API的参数编排规则:您可以通过不同算法规则,将请求参数映射为新的请求参数。 自定义API的错误响应信息:您可以通过网关响应功能,自定义响应状态码或网关响应内容。 克隆APIG的API:您可以通过克隆API功能,快速创建基本信息相同的API。
context.requestId 当次API调用生成请求ID $context.stage API调用的部署环境 $context.sourceIp API调用者的源地址 $context.authorizer.frontend.property 前端自定义认证响应的context映射的指定键值对的字符串值
如果本地数据中心的子网不在以下三个大子网段内,暂时不支持配置本地路由。 10.0.0.0/8-24 172.16.0.0/12-24 192.168.0.0/16-24 父主题: 管理APIG实例