检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API网关除了将传统的服务作为后端服务外,还可以将微服务集群作为后端服务进行开放。API网关后端对接CCE集群后,可以自动进行微服务发现,根据负载均衡策略将流量路由到微服务容器中,同时支持微服务的灰度发布。 函数工作流服务开放 API网关可以将无服务器服务(即函数工作流服务)作为后端服务开放给合作
set_resp_headers:HTTP响应头管理 kafka_log:Kafka日志推送 breaker:断路器 rate_limit: 流量控制 third_auth: 第三方认证 proxy_cache: 响应缓存 proxy_mirror: 请求镜像 plugin_scope
布的环境名称。 API认证鉴权 如果使用APP认证,Key和Secret是否正确。 API控制策略 访问控制策略是否设置正确。 是否超过了流量控制范围。系统默认的流控策略是单个API的访问不超过200次/秒,如果您未创建流控策略,API网关会执行默认流控策略。您可以在实例控制台“
set_resp_headers:HTTP响应头管理 kafka_log:Kafka日志推送 breaker:断路器 rate_limit: 流量控制 third_auth: 第三方认证 proxy_cache: 响应缓存 proxy_mirror: 请求镜像 plugin_scope
说明 API网关实例 通过实例版本计费,用于专享版。 API网关实例公网出口带宽 通过公网带宽计费,用于专享版。 API网关 通过使用量和流量计费,用于共享版。
set_resp_headers:HTTP响应头管理 kafka_log:Kafka日志推送 breaker:断路器 rate_limit: 流量控制 third_auth: 第三方认证 proxy_cache: 响应缓存 proxy_mirror: 请求镜像 plugin_scope
Integer 最大延时(ms) R avg_latency Double 平均耗时(ms) R output_throughput Integer 下行吞吐量(byte) R input_throughput Integer 上行吞吐量(byte) R req_count4xx Integer
创建API 把已有后端服务封装为标准RESTFul API,并对外开放。 API创建成功后,您可根据业务需求对API设置访问策略: 流控控制 流量控制可限制单位时间内API的被调用次数,保护后端服务。 访问控制 访问API的IP地址和账户,您可以通过设置IP地址或账户的黑白名单来拒绝/允许某个IP地址或账户访问API。
bandwidth_charging_mode 否 String 出公网带宽计费类型: bandwidth:按带宽计费 traffic:按流量计费 缺省值:bandwidth 响应参数 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String
set_resp_headers:HTTP响应头管理 kafka_log:Kafka日志推送 breaker:断路器 rate_limit: 流量控制 third_auth: 第三方认证 proxy_cache: 响应缓存 proxy_mirror: 请求镜像 plugin_scope
bandwidth_charging_mode 否 String 出公网带宽计费类型: bandwidth:按带宽计费 traffic:按流量计费 缺省值:bandwidth 响应参数 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String
对象模型 本节介绍特殊流控的对象模型,如下表所示: “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 特殊流控对象模型 参数 类型 说明 操作类型 是否必选
bandwidth_charging_mode 否 String 入公网带宽计费类型: bandwidth:按带宽计费 traffic:按流量计费 缺省值:bandwidth 响应参数 状态码: 202 表4 响应Body参数 参数 参数类型 描述 instance_id String
bandwidth_charging_mode 否 String 入公网带宽计费类型: bandwidth:按带宽计费 traffic:按流量计费 缺省值:bandwidth 响应参数 状态码: 202 表4 响应Body参数 参数 参数类型 描述 instance_id String
404 未匹配到API 请求参数错误 400 请求参数校验失败、不支持的HTTP方法 调用次数超出阈值 429 API调用次数超出所配置的流量策略阈值 应用未授权 401 使用的应用未被授权访问该API API网关运行时可获取变量 表2 网关错误响应消息体支持的变量 运行时变量名称
删除API 操作场景 已发布的API不再提供服务,可以将API删除。 该操作将导致此API无法被访问,可能会影响正在使用此API的应用或者用户,请确保已经告知用户。 已上架云商店的API,无法被删除。 已发布的API,需要先下线API,再删除。 操作步骤 进入共享版控制台。 单击“开放API
最大网关内部延时 R avg_inner_latency Double 平均网关内部延时 R output_throughput Integer 下行吞吐量(byte) R input_throughput Integer 上行吞吐量(byte) R req_count4xx Integer
404 未匹配到API 请求参数错误 400 请求参数校验失败、不支持的HTTP方法 调用次数超出阈值 429 API调用次数超出所配置的流量策略阈值 凭据未授权 401 使用的凭据未被授权访问该API API网关运行时可获取变量 表2 网关错误响应消息体支持的变量 运行时变量名称
API全局默认流控值,默认值为200次/秒。API未绑定流控策略时,执行此默认流控;API绑定流控策略时,则执行绑定的流控策略。流控策略的API流量限制值不能超过API全局默认流控值。 request_body_size API请求中允许携带的Body大小上限,默认值为12MB,可修改范围为1MB~9536MB。
后端不可用,网络不可达错误 BACKEND_TIMEOUT: 后端超时,与后端的网络交互超过预配置的时间错误 THROTTLED: API调用次数超出所配置的流量策略阈值 UNAUTHORIZED: 使用的凭据未被授权访问该API ACCESS_DENIED: 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截