检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
开放API流程 企业或开发者通过API网关开放自身的服务与数据，实现业务能力变现。 创建API分组 每个API都归属到某一个API分组下，在创建API前应提前创建API分组。 添加API的SSL证书 如果API分组中的API支持HTTPS请求协议，需要为独立域名添加SSL证书。反之
续费概述 包年/包月实例到期后会影响实例正常运行。如果您想继续使用，需要在指定的时间内为实例续费，否则实例资源会自动释放，数据丢失且不可恢复。 续费操作仅适用于包年/包月实例，按需计费实例不需要续费，只需要保证账户余额充足即可。 包年/包月实例在到期前续费成功，所有资源得以保留，且实例的运行不受影响
配置API的访问控制 访问控制策略是API网关提供的API安全防护组件之一，主要用来控制访问API的IP地址和账户，您可以通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址/账号名/账号ID访问API。实例级访问控制策略请参考表1。 访问控制策略和API本身是相互独立的，只有将访问控制策略绑定
配置API的响应缓存 您可以通过配置响应缓存策略将后端服务（服务端）返回的应答缓存在API网关中，当客户端发送相同的请求时，网关不用向后端传递请求，直接返回缓存的应答。有效降低后端的负荷，同时减少API调用的延迟。 当使用响应缓存策略时，后端的响应内容会缓存到API网关中，此时API
添加API的SSL证书 如果API分组中的API支持HTTPS请求协议，则在绑定独立域名后，还需为独立域名添加SSL证书。SSL证书是进行数据传输加密和身份证明的证书，支持单向认证和双向认证两种认证方式。 如果不配置SSL证书，将无法保障请求的链路安全，请谨慎配置。 单向认证：客户端与服务端连接时
配置API的调用域名 API分组创建后，系统为分组自动分配一个内部测试用的调试域名，此调试域名每天最多可以访问1000次。因此，在开放API前，您需要为API分组绑定独立域名，用户通过独立域名访问分组内的API。最多可以添加5个独立域名，不限访问次数。 独立域名可分为内网域名和公网域名两种
配置API的Kafka日志推送 Kafka日志推送策略提供了把API的详细调用日志推送到Kafka的能力，方便用户获取API的调用日志信息。 如果此策略在当前实例中不支持，可提交工单升级实例到最新版本。 策略参数会明文展示，为防止信息泄露，请谨慎配置。 约束与限制 同一个环境中，一个
配置API的跨域资源共享 出于安全性考虑，浏览器会限制从页面脚本内发起的跨域请求，此时页面只能访问当前域的资源。CORS允许浏览器向跨域服务器发送XMLHttpRequest请求，从而实现跨域访问。更多跨域访问的说明请参见跨域调用APIG开放的API。 跨域资源共享策略为跨域访问提供指定预检请求头和响应头
通过APIG创建GRPC API API网关支持创建GRPC API。gRPC是RPC（远程过程调用）的一种，只需定义每个API的Request和Response，剩下的gRPC框架就可以完成。它的典型特征就是使用protobuf（protocol buffers）作为其接口定义语言
使用APIG专享版实现WebSocket服务的转发 应用场景 API网关支持WebSocket API，其创建过程和创建HTTP API一致。WebSocket是一种全双工通信协议，建立在单个TCP连接上，允许在客户端和服务器之间进行双向通信。WebSocket的设计旨在解决HTTP
发布APIG创建的API 创建完成的API，支持发布到不同的环境。API只有在发布到环境后，才支持被调用。API网关支持查看API发布历史（如版本、发布说明、发布时间和发布环境），并支持回滚到不同的API历史版本。 约束与限制 已发布的API，在修改信息后，需要重新发布才能将修改后的信息同步到环境中
实施步骤 前提条件 客户端与服务端均为gRPC类型。 服务端已定义proto文件，即在proto文件中定义API的Request和Response。proto文件是用于定义数据结构和服务接口的文件，通常在gRPC中使用。它基于Protobuf语言，用于描述数据的结构和交互方式，充当客户端和服务端之间通信的合同
创建API的负载通道（可选） 负载通道主要用于将服务通过API网关专享版开放给外部访问。它的优势在于使用VPC的内部子网通信，网络时延更低，同时负载通道具有负载均衡功能（服务器通道类型），以及自动同步服务节点变更的能力（微服务通道类型）和使用已有的负载通道能力（引用负载通道类型），
配置API的第三方认证 您可以通过第三方认证策略配置自己的鉴权服务为API的访问进行认证。API网关先调用用户的鉴权服务，收到鉴权服务的鉴权成功响应后再继续调用后端服务。 如果此策略在当前实例中不支持，可提交工单升级实例到最新版本。 策略参数会明文展示，为防止信息泄露，请谨慎配置。
约束与限制 实例 表1 实例约束与限制 限制项 约束与限制 用户权限 如果您使用系统角色相关权限，需要同时拥有“APIG Administrator”和“VPC Administrator”权限才能创建实例。 如果您使用系统策略，则拥有“APIG FullAccess”即可。 网络
实施步骤 前提条件 已创建自定义认证函数，如果未创建请参考《函数工作流用户指南》中的创建函数章节创建，并且在函数的返回值中已设置context字段，字段中包含键值对。其中键值对的值只支持字符串、布尔、整型三种数值类型，键值对对应“系统参数-前端认证参数”策略条件的参数名称和条件值。
配置API的断路器 断路器是API网关在后端服务出现性能问题时保护系统的内置机制。当API的后端服务出现连续N次超时或者时延较高的情况下，会触发断路器的降级机制，向API调用方返回固定错误或者将请求转发到指定的降级后端。当后端服务恢复正常后，断路器关闭，请求恢复正常。 如果此策略在当前实例中不支持
Python 操作场景 使用Python语言进行后端服务签名时，您需要先获取SDK，然后导入工程，最后参考校验后端签名示例校验签名是否一致。 本章节以IntelliJ IDEA 2018.3.5版本为例介绍。 准备环境 已在API网关控制台创建签名密钥，并绑定API，具体请参见创建并使用签名密钥
Java 操作场景 使用Java语言进行后端服务签名时，您需要先获取SDK，然后导入工程，最后参考校验后端签名示例校验签名是否一致。 本章节以IntelliJ IDEA 2018.3.5版本为例介绍。 前提条件 已在API网关控制台创建签名密钥，并绑定API，具体请参见创建并使用签名密钥
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
