Jump To Close Expand all Collapse all Table of contents 管理 API 网关 前言 I. API 网关 Expand section "I. API 网关" Collapse section "I. API 网关" 1. 操作 APIcast Expand section "1. 操作 APIcast" Collapse section "1. 操作 APIcast" 1.1. 公共基础 URL 1.2. 映射规则 Expand section "1.2. 映射规则" Collapse section "1.2. 映射规则" 1.2.1. 在产品和后端映射规则 1.2.2. 映射规则的匹配 1.2.3. 映射规则工作流 1.3. 主机标头 1.4. 保护 API 后端 1.5. 将 APIcast 与私有 API 搭配使用 1.6. 使用 OpenTracing 配置 APIcast Expand section "1.6. 使用 OpenTracing 配置 APIcast" Collapse section "1.6. 使用 OpenTracing 配置 APIcast" 1.6.1. 先决条件 1.6.2. 流程 1.6.3. 附加信息 1.6.4. 在 OpenShift 实例上安装 Jaeger 2. 操作 Docker 容器化环境 Expand section "2. 操作 Docker 容器化环境" Collapse section "2. 操作 Docker 容器化环境" 2.1. 对 Docker 容器化环境的 APIcast 进行故障排除 Expand section "2.1. 对 Docker 容器化环境的 APIcast 进行故障排除" Collapse section "2.1. 对 Docker 容器化环境的 APIcast 进行故障排除" 2.1.1. 无法连接到 Docker 守护进程 错误 2.1.2. 基本 Docker 命令行界面命令 3. 高级 APIcast 配置 Expand section "3. 高级 APIcast 配置" Collapse section "3. 高级 APIcast 配置" 3.1. 定义 secret 令牌 3.2. 凭证 3.3. 配置错误消息 3.4. 配置历史记录 3.5. 调试 3.6. 路径路由 4. APIcast 策略 Expand section "4. APIcast 策略" Collapse section "4. APIcast 策略" 4.1. APIcast 标准策略 Expand section "4.1. APIcast 标准策略" Collapse section "4.1. APIcast 标准策略" 4.1.1. 3scale 身份验证缓存 4.1.2. 3scale Batcher 4.1.3. 3scale Referencerer 4.1.4. 匿名访问 4.1.5. Camel 服务 Expand section "4.1.5. Camel 服务" Collapse section "4.1.5. Camel 服务" 4.1.5.1. Configuration Expand section "4.1.5.1. Configuration" Collapse section "4.1.5.1. Configuration" 4.1.5.1.1. 使用案例示例 4.1.6. 条件策略 Expand section "4.1.6. 条件策略" Collapse section "4.1.6. 条件策略" 4.1.6.1. 条件 Expand section "4.1.6.1. 条件" Collapse section "4.1.6.1. 条件" 4.1.6.1.1. 颠覆性支持的变量 4.1.7. 内容缓存 Expand section "4.1.7. 内容缓存" Collapse section "4.1.7. 内容缓存" 4.1.7.1. 支持的配置 4.1.7.2. 上游响应标头 4.1.8. CORS 请求处理 4.1.9. 自定义指标 Expand section "4.1.9. 自定义指标" Collapse section "4.1.9. 自定义指标" 4.1.9.1. 自定义指标的限制 4.1.9.2. 请求流示例 4.1.9.3. 配置示例 4.1.10. echo 4.1.11. 边缘限制 Expand section "4.1.11. 边缘限制" Collapse section "4.1.11. 边缘限制" 4.1.11.1. 限制类型 4.1.11.2. 限制定义 4.1.11.3. 移动模板 4.1.11.4. 应用条件 4.1.11.5. 配置速率限制计数器的存储 4.1.11.6. 错误处理 4.1.12. 标头修改 4.1.13. IP 检查 4.1.14. JWT 申索检查 Expand section "4.1.14. JWT 申索检查" Collapse section "4.1.14. JWT 申索检查" 4.1.14.1. 关于 JWT 申索检查策略 4.1.14.2. 在策略链中配置 JWT 声明检查策略 Expand section "4.1.14.2. 在策略链中配置 JWT 声明检查策略" Collapse section "4.1.14.2. 在策略链中配置 JWT 声明检查策略" 4.1.14.2.1. 配置策略 4.1.15. 移动上下文调试 4.1.16. 日志 Expand section "4.1.16. 日志" Collapse section "4.1.16. 日志" 4.1.16.1. 所有 API 的全局配置 4.1.16.2. 示例 4.1.16.3. 有关自定义日志记录的附加信息 4.1.17. 维护模式 4.1.18. OAuth 2.0 通用 TLS 客户端身份验证 4.1.19. OAuth 2.0 令牌内省 4.1.20. 代理服务 Expand section "4.1.20. 代理服务" Collapse section "4.1.20. 代理服务" 4.1.20.1. Configuration Expand section "4.1.20.1. Configuration" Collapse section "4.1.20.1. Configuration" 4.1.20.1.1. 使用案例示例 4.1.21. 速率限制标头 Expand section "4.1.21. 速率限制标头" Collapse section "4.1.21. 速率限制标头" 4.1.21.1. RateLimit 标头 4.1.22. Retry 4.1.23. RH-SSO/Keycloak 角色检查 4.1.24. 路由 Expand section "4.1.24. 路由" Collapse section "4.1.24. 路由" 4.1.24.1. 路由规则 4.1.24.2. 请求路径规则 4.1.24.3. 标头规则 4.1.24.4. 查询参数规则 4.1.24.5. JWT 声明规则 4.1.24.6. 多操作规则 4.1.24.7. 组合规则 4.1.24.8. catch-all 规则 4.1.24.9. 支持的操作 4.1.24.10. 移动模板 4.1.24.11. 设置 host_header中使用的主机 4.1.25. SOAP 4.1.26. TLS 客户端证书验证 Expand section "4.1.26. TLS 客户端证书验证" Collapse section "4.1.26. TLS 客户端证书验证" 4.1.26.1. 设置 APIcast 以使用 TLS 客户端证书验证 Expand section "4.1.26.1. 设置 APIcast 以使用 TLS 客户端证书验证" Collapse section "4.1.26.1. 设置 APIcast 以使用 TLS 客户端证书验证" 4.1.26.1.1. 设置 APIcast 以使用策略 4.1.26.2. 在策略链中配置 TLS 客户端证书验证 Expand section "4.1.26.2. 在策略链中配置 TLS 客户端证书验证" Collapse section "4.1.26.2. 在策略链中配置 TLS 客户端证书验证" 4.1.26.2.1. 配置策略 4.1.26.3. 验证 TLS 客户端证书验证策略的功能 Expand section "4.1.26.3. 验证 TLS 客户端证书验证策略的功能" Collapse section "4.1.26.3. 验证 TLS 客户端证书验证策略的功能" 4.1.26.3.1. 验证策略功能 4.1.26.4. 从白名单中删除证书 Expand section "4.1.26.4. 从白名单中删除证书" Collapse section "4.1.26.4. 从白名单中删除证书" 4.1.26.4.1. 删除证书 4.1.26.5. 参考材料 4.1.27. TLS 终止 Expand section "4.1.27. TLS 终止" Collapse section "4.1.27. TLS 终止" 4.1.27.1. 在策略链中配置 TLS 终止 Expand section "4.1.27.1. 在策略链中配置 TLS 终止" Collapse section "4.1.27.1. 在策略链中配置 TLS 终止" 4.1.27.1.1. 配置策略 4.1.27.2. 验证 TLS 终止策略的功能 Expand section "4.1.27.2. 验证 TLS 终止策略的功能" Collapse section "4.1.27.2. 验证 TLS 终止策略的功能" 4.1.27.2.1. 验证策略功能 4.1.27.3. 从 TLS 终止中删除文件 Expand section "4.1.27.3. 从 TLS 终止中删除文件" Collapse section "4.1.27.3. 从 TLS 终止中删除文件" 4.1.27.3.1. 删除证书 4.1.28. 上游 4.1.29. 上游连接 Expand section "4.1.29. 上游连接" Collapse section "4.1.29. 上游连接" 4.1.29.1. 在策略链中配置上游连接 Expand section "4.1.29.1. 在策略链中配置上游连接" Collapse section "4.1.29.1. 在策略链中配置上游连接" 4.1.29.1.1. 配置策略 4.1.30. 上游双向 TLS Expand section "4.1.30. 上游双向 TLS" Collapse section "4.1.30. 上游双向 TLS" 4.1.30.1. 在策略链中配置上游双向 TLS 4.1.31. URL 重写 Expand section "4.1.31. URL 重写" Collapse section "4.1.31. URL 重写" 4.1.31.1. 重写路径的命令 4.1.31.2. 重写查询字符串的命令 4.1.32. 使用 Captures 重写 URL 4.2. 在管理门户中启用策略 4.3. 创建自定义 APIcast 策略 4.4. 将自定义策略添加到 APIcast Expand section "4.4. 将自定义策略添加到 APIcast" Collapse section "4.4. 将自定义策略添加到 APIcast" 4.4.1. 在 APIcast 部署中添加自定义策略 4.4.2. 在嵌入式 APIcast 中添加自定义策略 4.4.3. 在另一个 OpenShift Container Platform 上添加自定义策略到 APIcast 4.5. 在 3scale 中创建策略链 4.6. 创建策略链 JSON 配置文件 5. 将策略链与 APIcast 原生部署集成 Expand section "5. 将策略链与 APIcast 原生部署集成" Collapse section "5. 将策略链与 APIcast 原生部署集成" 5.1. 在策略中使用变量和过滤器 6. 使用 Fuse 中的策略扩展转换 3scale 消息内容 Expand section "6. 使用 Fuse 中的策略扩展转换 3scale 消息内容" Collapse section "6. 使用 Fuse 中的策略扩展转换 3scale 消息内容" 6.1. 在 Fuse 中集成 APIcast 与 Apache Camel 转换 6.2. 配置使用 OpenShift 上 Fuse 中的 Apache Camel 创建的 APIcast 策略扩展 7. APIcast 环境变量 8. 配置 APIcast 以获得更好的性能 Expand section "8. 配置 APIcast 以获得更好的性能" Collapse section "8. 配置 APIcast 以获得更好的性能" 8.1. 常规指南 8.2. 默认缓存 8.3. 异步报告线程 8.4. 3scale 批处理器策略 9. 向 Prometheus 公开 3scale APIcast Metrics Expand section "9. 向 Prometheus 公开 3scale APIcast Metrics" Collapse section "9. 向 Prometheus 公开 3scale APIcast Metrics" 9.1. 关于 Prometheus Expand section "9.1. 关于 Prometheus" Collapse section "9.1. 关于 Prometheus" 9.1.1. Prometheus 查询 9.2. APIcast 与 Prometheus 集成 Expand section "9.2. APIcast 与 Prometheus 集成" Collapse section "9.2. APIcast 与 Prometheus 集成" 9.2.1. 其他选项 9.3. 3scale APIcast 的 OpenShift 环境变量 9.4. 3scale APIcast 指标公开给 Prometheus II. API 版本控制 Expand section "II. API 版本控制" Collapse section "II. API 版本控制" 10. API 版本 Expand section "10. API 版本" Collapse section "10. API 版本" 10.1. 目标 10.2. 先决条件 10.3. URL 版本 10.4. 端点版本控制 10.5. 自定义标头版本 III. API 身份验证 Expand section "III. API 身份验证" Collapse section "III. API 身份验证" 11. 身份验证模式 Expand section "11. 身份验证模式" Collapse section "11. 身份验证模式" 11.1. 支持的验证模式 11.2. 设置身份验证模式 Expand section "11.2. 设置身份验证模式" Collapse section "11.2. 设置身份验证模式" 11.2.1. 选择服务的验证模式 11.2.2. 选择要使用的 Authentication 模式 11.2.3. 确保您的 API 接受正确类型的凭证 11.2.4. 创建用于测试凭证的应用程序 11.3. 标准验证模式 Expand section "11.3. 标准验证模式" Collapse section "11.3. 标准验证模式" 11.3.1. API 密钥 11.3.2. App_ID 和 App_Key 对 11.3.3. OpenID Connect 11.4. 参考器过滤 12. OpenID Connect 集成 Expand section "12. OpenID Connect 集成" Collapse section "12. OpenID Connect 集成" 12.1. APIcast 验证和解析 JWT 12.2. 由 zync-que同步客户端凭证 12.3. 配置红帽单点登录集成 Expand section "12.3. 配置红帽单点登录集成" Collapse section "12.3. 配置红帽单点登录集成" 12.3.1. 将ing zync-que 配置为使用自定义 CA 证书 12.3.2. 配置红帽单点登录 12.3.3. 配置 3scale 12.4. 配置与第三方身份提供程序的 HTTP 集成 Expand section "12.4. 配置与第三方身份提供程序的 HTTP 集成" Collapse section "12.4. 配置与第三方身份提供程序的 HTTP 集成" 12.4.1. 先决条件 12.4.2. 流程 12.4.3. Zync REST API 示例 Expand section "12.4.3. Zync REST API 示例" Collapse section "12.4.3. Zync REST API 示例" 12.4.3.1. 先决条件 12.4.3.2. 创建、更新和删除客户端 12.4.3.3. payload 12.4.3.4. 使用 OAuth2 身份验证 12.5. OAuth 2.0 支持的流 Expand section "12.5. OAuth 2.0 支持的流" Collapse section "12.5. OAuth 2.0 支持的流" 12.5.1. OAuth 2.0 支持的流的工作方式 12.5.2. 配置 OAuth 2.0 支持的流 12.6. 测试集成 Expand section "12.6. 测试集成" Collapse section "12.6. 测试集成" 12.6.1. 测试客户端同步 12.6.2. 测试 API 授权流 12.7. 集成示例 Settings Close Language: 한국어 简体中文 日本語 English Language: 한국어 简体中文 日本語 English Format: Multi-page Single-page Format: Multi-page Single-page Language and Page Formatting Options Language: 한국어 简体中文 日本語 English Language: 한국어 简体中文 日本語 English Format: Multi-page Single-page Format: Multi-page Single-page 10.2. 先决条件 在使用此快速启动指南之前,完成将 API 连接到 3scale 的 基础知识。 Previous Next