检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
修改流控策略 功能介绍 修改指定流控策略的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1/{project_id}/apigw/instances/{instance_id}/throttles/{id}
使用APIG的APP认证和自定义认证实现API的双重认证 应用场景 双重认证指用户根据业务需求自定义API认证策略,再结合APP认证/IAM认证,从而实现API的双重认证方式,保障API的安全性。本文以API前端认证使用APP认证和自定义认证结合场景为例,具体说明如何创建使用双重认证的API。
导入API 操作场景 API网关支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具,可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入,主要取决于Swagger文件中包含的API数量。
配置API的HTTP响应头 API响应是指API网关向客户端返回的响应,HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头,在返回的API响应中指定您配置的响应头。 如果此策略在当前实例中不支持,请联系技术支持升级实例到最新版本。 策略参数会明文展示,为防止信息泄露,请谨慎配置。
通过APIG创建GRPC API API网关支持创建GRPC API。gRPC是RPC(远程过程调用)的一种,只需定义每个API的Request和Response,剩下的gRPC框架就可以完成。它的典型特征就是使用protobuf(protocol buffers)作为其接口定义语言(Interface
使用APIG专享版实现WebSocket服务的转发 应用场景 API网关支持WebSocket API,其创建过程和创建HTTP API一致。WebSocket是一种全双工通信协议,建立在单个TCP连接上,允许在客户端和服务器之间进行双向通信。WebSocket的设计旨在解决HT
查看分组详情 功能介绍 查询指定分组的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/api-groups/{id} URI中的参数说明如下表所示。 表2 参数说明
配置APIG的API简易认证AppCode 简易认证指在调用API时,HTTP请求头部消息增加一个参数X-Apig-AppCode(参数值填凭据详情中“AppCode”的值),而不需要对请求内容签名,API网关也仅校验AppCode,不校验请求签名,从而实现快速响应。 当使用AP
创建APIG实例 本小节指导您顺利创建实例,实例创建完成后,才能创建API并对外提供服务。 约束与限制 实例配额 同一项目ID下,一个主账号默认只能创建5个实例。如果您需要创建更多实例,可提交工单,申请修改配额。 用户权限 如果您使用系统角色相关权限,需要同时拥有“APIG Administrator”和“VPC
配置API的流量控制2.0 流量控制2.0策略可以限制单位时间内API的被调用次数,支持参数流控、基础流控和基于基础流控的特殊流控。 基础流控 可以对API、用户、凭据、源IP进行多维度流控,与已有的配置API的流量控制功能一致但不兼容。 参数流控 支持根据Header、Path
创建流控策略 功能介绍 当API上线后,系统会默认给每个API提供一个流控策略,API提供者可以根据自身API的服务能力及负载情况变更这个流控策略。 流控策略即限制API在一定长度的时间内,能够允许被访问的最大次数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1
使用APIG专享版实现不同后端服务的调用实施步骤 前提条件 已创建自定义认证函数,如果未创建请创建函数章节创建,并且在函数的返回值中已设置context字段,字段中包含键值对。其中键值对的值只支持字符串、布尔、整型三种数值类型,键值对对应“系统参数-前端认证参数”策略条件的参数名称和条件值。
创建API分组 功能介绍 API分组是API的管理单元,一个API分组等同于一个服务入口,创建API分组时,返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。 专享版API网关已经陆续开放V2版本的接口,请优先使用V2版本接口管理您的API。 URI HT
配置API的第三方认证 您可以通过第三方认证策略配置自己的鉴权服务为API的访问进行认证。API网关先调用用户的鉴权服务,收到鉴权服务的鉴权成功响应后再继续调用后端服务。 如果此策略在当前实例中不支持,可提交工单升级实例到最新版本。 第三方认证原理图如下,第三方认证策略绑定API
查看流控策略详情 功能介绍 查看指定流控策略的详细信息。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id} 表1 路径参数 参数 是否必选
查询分组列表 功能介绍 查询API分组列表。 如果是租户操作,则查询该租户下所有的分组;如果是管理员操作,则查询的是所有租户的分组。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{pr
创建专享版实例(包周期) 功能介绍 创建包周期专享版实例。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/prepay-instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。
修改流控策略 功能介绍 修改指定流控策略的详细信息。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id} 表1 路径参数 参数 是否必选 参数类型
查询单个实例标签 功能介绍 查询单个实例的标签。 接口约束 使用策略授权用户时,需要包含apig:instanceTags:list、apig:instances:get的授权项才允许调用此接口 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/
查询流控策略列表 功能介绍 查询所有流控策略的信息。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/throttles 表1 路径参数 参数 是否必选 参数类型 描述 project_id