检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用APIG专享版实现WebSocket服务的转发 应用场景 API网关支持WebSocket API，其创建过程和创建HTTP API一致。WebSocket是一种全双工通信协议，建立在单个TCP连接上，允许在客户端和服务器之间进行双向通信。WebSocket的设计旨在解决HTTP协议在实时性和交互
查询分组列表 功能介绍 查询API分组列表。 如果是租户操作，则查询该租户下所有的分组；如果是管理员操作，则查询的是所有租户的分组。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{pr
查询分组列表 功能介绍 查询API分组列表。 如果是租户操作，则查询该租户下所有的分组；如果是管理租户操作，则查询的是所有租户的分组。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/api-groups[
配置APIG专享版与客户端间的单向认证或双向认证 应用场景 API前端定义中的请求协议支持HTTPS时，API所属分组在绑定独立域名后，还需为独立域名添加SSL证书。SSL证书是进行数据传输加密和身份证明的证书，当SSL证书带有CA证书时，默认开启客户端认证即双向认证；反之，开启单向认证。 单向认证：客户端与服务端连
添加API的SSL证书 如果API分组中的API支持HTTPS请求协议，则在绑定独立域名后，还需为独立域名添加SSL证书。SSL证书是进行数据传输加密和身份证明的证书，支持单向认证和双向认证两种认证方式。 如果不配置SSL证书，将无法保障请求的链路安全，请谨慎配置。 单向认证：客
使用APIG专享版实现gRPC服务的路由转发方案概述 应用场景 gRPC是RPC（远程过程调用）的一种，只需定义每个API的Request和Response，剩下的gRPC框架就可以完成。它的典型特征是使用protobuf（protocol buffers）作为其接口定义语言（Interface
配置API的发布环境和环境变量（可选） 环境是指API的受限使用范围，API只有在发布到环境后，才能被调用。API可以被发布到不同的自定义环境中，如开发环境、测试环境等。RELEASE是系统默认的发布环境，也是正式发布环境。 环境变量是指在环境上创建的一种变量，该变量固定在环境上
x-apigateway-pass-through 含义：API的请求参数是否透传。always为是，never为否。 作用域： Operation Object(2.0)/Operation Object(3.0) 示例： paths: /: get: parameters:
查看APIG的监控指标 云监控对API网关的运行状态进行日常监控，可以通过控制台直观的查看API网关各项监控指标。 查看单个API的监控指标 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称，进入“分组信息”页面。
project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String
API的响应码如何定义？ API响应码分两种类型。 一种是网关响应码。当请求到达网关时，由于API的流量控制、访问控制策略以及认证失败，网关直接返回的响应信息。有关网关响应的详细指导，请参考自定义API的错误响应信息。 一种是后端服务响应。响应信息由后端API服务（即API的提供者）定义，API网关只做透传。
project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String
Programming Interface，应用程序编程接口）是一些预先定义的函数，应用将自身的服务能力封装成API，并通过API网关开放给用户调用。 API包括基本信息、前后端的请求路径和参数以及请求相关协议。 API分组 API分组是同一种业务API的集合，API开发者以API分组为单位，管理分组内的所有API。
API的后端服务是否支持绑定私网ELB地址？ 专享版支持绑定私网ELB地址。 共享版不支持绑定私网ELB地址，请使用VPC通道。 如果是公网ELB地址，可直接使用。 父主题： 开放API
操作场景 API可以同时提供给不同的环境调用，如生产、测试或开发。RELEASE是默认存在的环境，无需创建。且API网关提供环境变量功能，通过创建环境变量，实现在不同的环境定义不同的API调用路径。 环境变量是指在环境上创建可管理的一种变量，该变量固定在环境上。通过创建环境变量，实现同
API访问控制策略配置的IP地址是否为客户端的IP地址？ 访问控制策略的IP地址不一定取客户端的IP地址。 APIG的访问控制是根据$remote_addr的值进行校验。$remote_addr代表客户端的IP，它的值是服务端根据客户端的IP指定的，当客户端访问APIG时，如果中间没有任何代理，那么就会把remo
专享版API网关提供包年/包月和按需两种计费模式，以满足不同场景下的用户需求。包年/包月是一种预付费模式，即先付费再使用，按照订单的购买周期进行结算，因此在购买之前，您必须确保账户余额充足。按需计费是一种后付费模式，即先使用再付费，按照API网关实际使用时长计费。关于计费模式的详细介绍请参见计费模式概述。
创建访问控制策略 操作场景 访问控制策略是API网关提供的API安全防护组件之一，主要用来控制访问API的IP地址和账户，您可以通过设置IP地址或账户的黑白名单来拒绝/允许某个IP地址或账户访问API。 访问控制策略和API本身是相互独立的，只有将访问控制策略绑定API后，访问控制策略才对绑定的API生效。
算器页面底部，您将看到所需的配置费用。 图1 配置费用示例 计费周期 包年/包月API网关的计费周期是根据您购买的时长来确定的（以GMT+08:00时间为准）。一个计费周期的起点是您开通或续费的时间（精确到秒），终点则是到期日的23:59:59。 例如，如果您在2023/03/08
配置API的访问控制 访问控制策略是API网关提供的API安全防护组件之一，主要用来控制访问API的IP地址和账户，您可以通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址/账号名/账号ID访问API。实例级访问控制策略请参考表1。 访问控制策略和API本身是相互独立的，只有将访问控
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
