检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用APIG专享版开放本地数据中心的服务能力 应用场景 API网关的后端服务有3类部署形态: 后端服务部署在虚拟私有云(以下简称VPC)中,仅支持私有地址访问。 可在API网关创建VPC通道,利用VPC通道,打通API网关与虚拟私有云的网络路由。 后端服务部署在公网环境中,即可以直接通过公网地址访问
list:列表中的值映射成另外的值。 range:范围中的值映射成另外的值。 hash:请求头的值经过哈希计算后直接映射为新的请求头。 hash_range:先用请求参数生成hash值,再用hash值进行range编排。
API网关导入或导出的OAS对象,与API网关对象定义的映射关系。 请求参数类型与API网关参数类型差异。 API请求路径模板语法差异。 导入API时支持的API网关扩展字段。
x-apigateway-access-controls 含义:访问控制策略名称与关联策略映射。
orchestration_map 否 Array of OrchestrationMap objects 编排映射规则列表,列表长度范围为1-300。 编排映射规则的生效优先级与列表顺序保持一致,列表中靠前的配置匹配优先级较高。
将调用API时传入的参数映射到后端服务对应的位置。 在“后端服务参数”右侧单击,通过以下任意一种方法配置后端服务参数。 单击“导入入参定义”,系统自动添加已创建的所有入参参数。 单击“添加后端参数映射”,按照需求添加您所需要的后端参数映射。
最小长度:3 最大长度:64 orchestration_strategy String 编排策略,有以下几种策略类型: list:列表; hash:哈希; range:区间; hash_range: 哈希+区间; none_value: 空值映射; default: 默认值映射;
$context.authorizer.backend.property 后端自定义认证响应的context映射的指定键值对的字符串值 $context.error.message 当前网关错误响应的错误信息 $context.error.code 当前网关错误响应的错误码 $context.error.type
x-apigateway-ratelimits 含义:流控策略名称与关联策略映射。
后端认证通过后,context中的user的值abc映射到后端服务Header位置的test参数中,并将其传递给API的后端服务。
orchestration_map Array of OrchestrationMap objects 编排映射规则列表,列表长度范围为1-300。 编排映射规则的生效优先级与列表顺序保持一致,列表中靠前的配置匹配优先级较高。
前端认证通过后,context中的user的值abc映射到后端服务Header位置的test参数中。
orchestration_map 否 Array of OrchestrationMap objects 编排映射规则列表,列表长度范围为1-300。 编排映射规则的生效优先级与列表顺序保持一致,列表中靠前的配置匹配优先级较高。
映射后端参数 添加系统参数,将函数返回的context信息传到后端。 验证 调用API,观察是否成功返回函数的context信息。 编写自定义认证函数 在函数工作流的控制台编写函数,自定义认证的代码编写指南参见创建用于前端自定义认证的函数。
配置API的参数编排规则:您可以通过不同算法规则,将请求参数映射为新的请求参数。 自定义API的错误响应信息:您可以通过网关响应功能,自定义响应状态码或网关响应内容。 克隆APIG的API:您可以通过克隆API功能,快速创建基本信息相同的API。
origin 是 String 参数映射来源,支持REQUEST、CONSTANT。 description 否 String 参数含义描述。 父主题: APIG的API设计文件扩展定义
查看API基本信息、API请求、后端请求、入参定义、参数映射、常量参数和返回结果。 如果想要设置之前版本为当前版本,则在版本所在行,单击“切换至此版本”,弹出“切换至此版本”对话框。 单击“确定”,完成版本的切换。此时版本号旁边显示“当前版本”,说明设置成功。
单击“添加后端参数映射”,按需逐个添加后端服务参数。 根据后端服务实际的参数名称和参数位置修改映射关系,如图1所示。 图1 配置后端服务参数 后端参数在“PATH”位置,那么参数名称需要和“路径”中的名称相同。 调用API的请求参数名称、位置可以与后端参数名称、位置不同。
context.requestId 当次API调用生成请求ID $context.stage API调用的部署环境 $context.sourceIp API调用者的源地址 $context.authorizer.frontend.property 前端自定义认证响应的context映射的指定键值对的字符串值
查看API基本信息、API请求、后端请求、入参定义、参数映射、常量参数和返回结果。 如果想要设置之前版本为当前版本,则在版本所在行,单击“切换至此版本”,弹出“切换至此版本”对话框。 单击“确定”,完成版本的切换。此时版本号旁边显示“当前版本”,说明设置成功。