检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
前提条件 客户端与服务端均为gRPC类型。 服务端已定义proto文件，即在proto文件中定义API的Request和Response。proto文件是用于定义数据结构和服务接口的文件，通常在gRPC中使用。它基于Protobuf语言，用于描述数据的结构和交互方式，充当客户端和服务端之间通信的合同。
Synchronous：同步调用。指后端函数服务收到调用请求后立即执行并返回调用结果，客户端发送请求后同步等待，收到后端响应后关闭连接。 Asynchronous：异步调用。客户端不关注请求调用的结果，服务端收到请求后将请求排队，排队成功后请求就返回，服务端在空闲的情况下会逐个处理排队的请求。 后端超时(ms)
创建环境和环境变量 操作场景 API可以同时提供给不同的环境调用，如生产、测试或开发。RELEASE是默认存在的环境，无需创建。且API网关提供环境变量功能，通过创建环境变量，实现在不同的环境定义不同的API调用路径。 环境变量是指在环境上创建可管理的一种变量，该变量固定在环境上
配置API的发布环境和环境变量（可选） 环境是指API的受限使用范围，API只有在发布到环境后，才能被调用。API可以被发布到不同的自定义环境中，如开发环境、测试环境等。RELEASE是系统默认的发布环境，也是正式发布环境。 环境变量是指在环境上创建的一种变量，该变量固定在环境上。如果API的后端服
在已绑定独立域名所在行单击“选择SSL证书”。 选择已创建的证书并勾选“开启客户端认证”，单击“确定”。 调用API。 使用接口测试工具调用API，状态码为“200”表示调用成功。否则，请参考错误码章节处理。 由于开启了双向认证，因此在访问API时需要配置客户端证书。 如果使用Postman调用API，则需要在
域名是否备案成功，且能正常解析。 域名是否绑定到正确的API分组。 子域名（调试域名）访问超过默认次数。API分组创建后，系统为分组自动分配一个内部测试用的子域名，此子域名唯一且不可更改，每天最多可以访问1000次。您可以通过添加独立域名来访问您开放的API。 发布问题 API是否已发布。
自定义APIG的客户端访问端口 API网关提供自定义实例入端口功能，支持客户端通过不同的端口来访问不同的后端服务。 约束与限制 新增端口时，一个端口仅允许配置一种协议。当前仅支持HTTP和HTTPS协议。 独立域名与端口相关约束与限制内容，请参考约束与限制。 自定义客户端访问端口 进入API网关控制台页面。
如果不配置SSL证书，将无法保障请求的链路安全，请谨慎配置。 单向认证：客户端与服务端连接时，客户端需要验证所连接的服务端是否正确。 双向认证：客户端与服务端连接时，除了客户端需要验证所连接的服务器是否正确之外，服务端也需要验证接入的客户端是否正确。 约束与限制 仅支持添加pem编码格式的SSL证书。
API访问控制策略配置的IP地址是否为客户端的IP地址？ 访问控制策略的IP地址不一定取客户端的IP地址。 APIG的访问控制是根据$remote_addr的值进行校验。$remote_addr代表客户端的IP，它的值是服务端根据客户端的IP指定的，当客户端访问APIG时，如果中间没有任何
开启客户端认证即双向认证；反之，开启单向认证。 单向认证：客户端与服务端连接时，客户端需要校验服务端SSl证书合法性。 双向认证：客户端与服务端连接时，除了客户端需要校验服务端SSl证书合法性，服务端也需要校验客户端SSl证书合法性。 父主题： 配置APIG专享版与客户端间的单向认证或双向认证
配置APIG专享版与客户端间的单向认证或双向认证 方案描述 操作流程 实施步骤 父主题： API认证
将API所属的分组与已备案且解析的独立域名绑定。 绑定证书 将独立域名和已创建的SSL证书绑定。 调用API 验证API是否调用成功。 父主题： 配置APIG专享版与客户端间的单向认证或双向认证
API网关支持WebSocket API，其创建过程和创建HTTP API一致。WebSocket是一种全双工通信协议，建立在单个TCP连接上，允许在客户端和服务器之间进行双向通信。WebSocket的设计旨在解决HTTP协议在实时性和交互性方面的不足。它广泛应用于实时聊天、在线游戏、金融行业的实时数据更新等场景。
} return json.dumps(resp) 配置测试事件并调试代码，然后部署。 在下拉框中选择“配置测试事件”并配置。测试事件的参数值与环境变量中的参数值需要保持一致。 创建测试事件完成后，单击“测试”调试代码。如下图，表示代码调试成功。 调试成功后，单击“部署”。
return json.dumps(resp) 测试函数。在测试事件的“事件模板”中选择“空白模板”，内容为： {"user_data": "123"} 根据实际情况修改后保存测试模板，单击“测试”。 执行结果为“成功”时，表示测试成功。 接下来您需要进入API网关界面创建后端自定义认证。
} return json.dumps(resp) 测试函数。在测试事件的“事件模板”中选择“apig-event-template”，根据实际情况修改后保存测试模板，单击“测试”。 执行结果为“成功”时，表示测试成功。 接下来您需要进入API网关界面创建前端自定义认证。 后续操作
在“关联路由”页签中单击“添加路由”。 在弹窗中填写路由信息。 表6 本端和对端的路由信息 参数 说明 本端路由 虚拟私有云 已创建的虚拟私有云“VPC1”。 路由表 VPC1的路由表。 目的地址 为ELB详情页面，“基本信息”页签中的“服务地址”。 对端路由 虚拟私有云 已创建的虚拟私有云“VPC2”。
专享版实例可以根据需要分别开启公网入口和公网出口，每个实例都会有单独的公网入口IP和公网出口IP，该IP与原有的共享版IP不同，如果上游和下游（服务端和客户端）的相关服务有网络安全策略的设置，需要修改相应的网络安全策略，放通对应IP的访问。 内网出入口的变化 每个专享版实例都会拥有一个VPC内
APIG是否支持双向认证？ 专享版：支持。 前端双向认证。在绑定独立域名时，选择带有CA证书的SSL证书，开启客户端认证即双向认证。 后端双向认证。在创建API时，配置双向认证，在API网关和后端服务间启用双向认证。配置请参考创建API中的“TLS双向认证”参数说明。 共享版：不
通过APIG提供的在线调试功能验证API服务是否正常可用。 配置API的发布环境和环境变量（可选） API可以同时提供给不同的环境调用，如生产、测试或开发。RELEASE是系统默认的发布环境，如果使用RELEASE环境，可跳过配置发布环境步骤。 如果API的后端服务信息中定义了环境变量
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
