API网关 APIG
API网关 APIG
- 最新动态
- 功能总览
- 服务公告
- 产品介绍
- 计费说明
- 快速入门
-
用户指南
- APIG业务使用流程
- 创建用户并授权使用APIG
- 创建APIG实例
- 开放API
- 配置API调用授权(可选)
- 调用API
-
管理API
- 管理API概述
- 查看或编辑APIG的API信息
- 配置API的自定义认证
- 配置API的参数编排规则
- 自定义API的错误响应信息
- 克隆APIG的API
- 下线APIG的API
- 导入导出API
-
APIG的API设计文件扩展定义
- x-apigateway-auth-type
- x-apigateway-request-type
- x-apigateway-match-mode
- x-apigateway-cors
- x-apigateway-is-send-fg-body-base64
- x-apigateway-any-method
- x-apigateway-backend
- x-apigateway-backend.parameters
- x-apigateway-backend.httpEndpoints
- x-apigateway-backend.httpVpcEndpoints
- x-apigateway-backend.functionEndpoints
- x-apigateway-backend.mockEndpoints
- x-apigateway-backend-policies
- x-apigateway-backend-policies.conditions
- x-apigateway-ratelimit
- x-apigateway-ratelimits
- x-apigateway-ratelimits.policy
- x-apigateway-ratelimits.policy.special
- x-apigateway-access-control
- x-apigateway-access-controls
- x-apigateway-access-controls.policy
- x-apigateway-plugins
- x-apigateway-auth-opt
- x-apigateway-result-normal-sample
- x-apigateway-result-failure-sample
- x-apigateway-authorizer
- x-apigateway-response
- x-apigateway-responses
- x-apigateway-pass-through
- x-apigateway-sample
- x-apigateway-content-type
- x-apigateway-orchestrations
- 配置API策略
- 配置凭据策略
- 管理APIG实例
- 查看监控指标与配置告警
- 查看APIG审计日志
- 共享版操作指导(仅存量用户使用)
- 最佳实践
- 开发指南
-
API参考
- 使用前必读
- API概览
- 如何调用API
-
专享版API(V2)
- 专享版-API分组管理
- 专享版-环境管理
- 专享版-环境变量管理
- 专享版-流控策略管理
- 专享版-API管理
- 专享版-签名密钥管理
- 专享版-签名密钥绑定关系管理
- 专享版-API绑定流控策略
- 专享版-设置特殊流控
- 专享版-APP授权管理
- 专享版-概要查询
- 专享版-域名管理
- 专享版-ACL策略管理
- 专享版-API绑定ACL策略
- 专享版-自定义认证管理
- 专享版-OpenAPI接口
- 专享版-VPC通道管理
- 专享版-监控信息查询
- 专享版-分组自定义响应管理
- 专享版-标签管理
- 专享版-实例特性管理
- 专享版-配置管理
- 专享版-实例管理
- 专享版-实例终端节点管理
- 专享版-实例标签管理
- 专享版-微服务中心管理
- 专享版-SSL证书管理
- 专享版-插件管理
- 专享版-凭据管理
- 专享版-凭据配额管理
- 专享版-异步任务管理
- 专享版-编排规则管理
- 专享版-实例自定义入方向端口管理
- 共享版API(仅存量用户使用)
- 专享版API(V1)(待下线)
- 权限策略和授权项
- 附录
- 修订记录
- SDK参考
- 场景代码示例
-
常见问题
- 热门咨询
- 产品咨询
- 开放API
- 发布API
-
调用API
- 调用API失败的可能原因
- 调用API报“414 Request URI too large”
- 调用API报“The API does not exist or has not been published in the environment”
- 调用API报“No backend available”
- API的后端服务报“Backend unavailable”或“Backend timeout”
- API的后端服务报“Backend domain name resolution failed”
- 调用API报“Incorrect IAM authentication information”
- 调用API报“Incorrect app authentication information”
- 修改API后端服务的超时时间上限“backend_timeout”后未生效
- APIG对API请求体的大小是否有限制?
- API调用对请求的响应消息体限制
- 使用iOS系统时,如何使用APP认证调用API?
- 新建一个华为IAM认证方式的API,在配置入参时为什么无法配置HEADER位置的x-auth-token?
- 是否支持移动应用调用API?
- 部署在VPC下的应用是否可以调用API?
- APIG是否支持WebSocket数据传输?
- API的策略后端有多个时,怎么匹配和执行API请求?
- 如何通过APIG访问公网后端服务?
- API认证
- API策略
- 导入导出API
- 视频帮助
- 文档下载
- 通用参考
本文导读
展开导读
链接复制成功!
配置API的参数编排规则
API网关支持对API进行参数编排,根据请求参数取值,配置不同算法规则,映射为新的请求参数和新的参数值。
创建编排规则
- 进入API网关控制台页面。
- 根据实际业务在左侧导航栏上方选择实例。
- 在左侧导航栏选择“API管理 > API策略”。
- 单击“编排规则管理”页签。
- 单击“创建编排规则”,根据下表参数说明,配置编排规则。
表1 编排规则配置 参数
说明
规则名称
填写编排规则的名称,根据规划自定义。支持英文、数字、下划线,且只能以英文开头,长度为3~64个字符。
编排策略
选择编排策略。
- list:列表中的值映射成另外的值。
- range:范围中的值映射成另外的值。
- hash:请求头的值经过哈希计算后直接映射为新的请求头。
- hash_range:先用请求参数生成hash值,再用hash值进行range编排。
- none_value:请求参数为空时将返回none_value策略的编排映射值。
- default:请求参数存在,但是没有编排规则可以匹配上请求参数时,将返回default策略的编排映射值。
- head_n:用于截取字符串前n项(如果n大于字符串长度,会返回完整的原始参数值),生成一个临时参数,后面的编排规则用这个临时参数值进行编排。
- tail_n:用于截取字符串后n项(如果n大于字符串长度,会返回完整的原始参数值),生成一个临时参数,后面的编排规则用这个临时参数值进行编排。
是否预处理策略
当“编排策略”选择“list”、“range”、“hash”、“hash_range”、“head_n”、“tail_n”时可见。
配置是否预处理策略。当编排规则为预处理时,将该编排规则生成的参数值作为临时参数,成为下一个编排规则的待编排参数。
参数名称
当“是否预处理策略”开关关闭或者“编排策略”选择“none_value”或“default”时需要配置。
填写编排后的参数名称。支持英文、数字、中划线,且只能以英文开头,长度为1~128个字符。
参数类型
当“是否预处理策略”开关关闭或者“编排策略”选择“none_value”或“default”时需要配置。
选择参数类型。
- string
- number
参数位置
当“是否预处理策略”开关关闭或者“编排策略”选择“none_value”或“default”时需要配置。
选择参数位置。
- header
- query
映射信息
当“编排策略”选择“list”、“range”、“hash_range”、“none_value”、“default”时需要配置。
填写参数映射信息。支持英文、数字、下划线、中划线,且只能以英文开头,长度为1~128个字符。多个参数值用英文逗号分隔,最多支持3000个参数。
单击“新增映射信息”,可添加新的映射信息。
- 编排前的请求参数值
- 当“编排策略”选择“list”,输入编排前的请求参数值。
- 当“编排策略”选择“range”或“hash_range”,输入区间起始值和终止值。
- 编排后的请求参数值:输入编排后的请求参数值。
截取长度
当“编排策略”选择“head_n”或“tail_n”时需要配置。
配置截取字符串的长度,取值范围为1~100。
- 单击“确定”。
父主题: 管理API