检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
配置API的前端自定义认证 如果您需要把自己的认证系统用于API调用的认证鉴权,可以使用自定义认证来实现。 自定义认证包括前端和后端两种类型: 前端自定义认证:指APIG使用自定义的认证函数,对收到的API请求进行安全认证。 后端自定义认证:指API的后端服务使用自定义的认证函数
创建API的负载通道(可选) 如果需要访问指定服务器中已部署的后端服务,可通过创建负载通道来实现。反之,跳过此步骤。 创建API 把已有后端服务封装为标准RESTFul API或GRPC API,并对外开放。 API创建成功后,您可根据业务需求配置API策略,管理API等。 调试APIG创建的API
String 插件可见范围。global:全局可见; plugin_content String 插件定义内容,支持json。参考提供的具体模型定义 CorsPluginContent:跨域资源共享 定义内容 SetRespHeadersContent:HTTP响应头管理 定义内容
致,则可证明API请求确实来自API网关,而不是其他伪造请求。 VPC通道(负载通道) API网关通过VPC通道访问部署在VPC内的服务,您可以借助API网关将部署在VPC中的后端服务开放给第三方用户调用。 自定义认证 自定义认证指在API调用过程中,用户可自行定义认证规则,实现
分组下指定错误类型的自定义响应,删除分组指定错误类型的自定义响应配置。 标签管理 包括标签列表的查询。 实例特性管理 包括实例特性的配置,查看实例特性列表。 配置管理 包括查看某实例的租户配置列表,查询租户实例配置列表。 实例管理 包括: 实例的创建、更新、查看、删除,查看实例创建进度,查询实例列表。
String 插件可见范围。global:全局可见; plugin_content String 插件定义内容,支持json。参考提供的具体模型定义 CorsPluginContent:跨域资源共享 定义内容 SetRespHeadersContent:HTTP响应头管理 定义内容
String 插件可见范围。global:全局可见; plugin_content String 插件定义内容,支持json。参考提供的具体模型定义 CorsPluginContent:跨域资源共享 定义内容 SetRespHeadersContent:HTTP响应头管理 定义内容
修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截 自定义认证配置错误 500 自定义认证方异常,通信失败、返回异常响应等错误 自定义认证失败 500 自定义认证方返回认证失败 自定义认证身份来源错误
如果修改完默认网关响应后,需要恢复默认配置,单击“恢复默认配置”即可。 网关错误响应类型说明 API网关提供的错误响应类型见下表,其中响应状态码可以按实际需要做自定义修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截
策略内容 策略的配置内容,支持表单配置和脚本配置两种方式。 响应缓存键 配置参数作为响应缓存键,用于区分不同的缓存。 system_params类型:配置不同的网关内置系统参数作为响应缓存键来区分缓存。配置参数请参考网关内置参数。 parameters类型:配置不同的请求query参数作为响应缓存键来区分缓存。
降级参数配置 降级参数配置开关。开启后可为断路器自定义规则,API请求优先匹配自定义规则中的触发条件和降级策略,仅当未匹配到自定义规则时才执行上方配置的默认触发条件和降级策略。 如果匹配到自定义规则,则执行规则内配置的触发条件和降级策略。如果匹配到的自定义规则内未配置触发条件或
IP地址:限制调用API的IP地址。 账号名:仅适用IAM认证类型的API,限制调用API的账号名。仅支持配置账号名,对账号名及账号名下的IAM用户名做限制,不支持配置IAM用户名。 可以配置单账号名或多账号名,多账号名以英文格式下的逗号“,”隔开,账号名支持除英文格式下“,”以外的任意A
度为3~255个字符。 策略类型 固定为“流量镜像”。 描述 填写策略的描述信息。长度为1~255个字符。 策略内容 策略的配置内容,支持表单配置和脚本配置两种方式。 镜像协议 镜像请求协议。指定的镜像服务协议须与用户的镜像业务协议保持一致。 镜像地址 镜像服务的地址。由IP/域
配置API的流量控制 流量控制支持从用户、凭据和时间段等不同的维度限制对API的调用次数,保护后端服务。支持按分/秒粒度级别的流量控制。为了提供持续稳定的服务,您可以通过配置流控策略,针对部分API进行流量控制。 约束与限制 API配置流控策略相当于流控策略同步绑定了API。同一
~255个字符。 策略类型 固定为“HTTP响应头”。 描述 填写策略的描述信息。长度为1~255个字符。 策略内容 策略的配置内容,支持表单配置和脚本配置两种方式。 Name 响应头名称。每个策略中不能添加重复名称的响应头(不区分大小写),且最多添加10条响应头。 支持英文,数
55个字符。 策略类型 固定为“Kafka日志推送”。 描述 填写策略的描述信息。长度为1~255个字符。 策略内容 策略的配置内容,支持表单配置和脚本配置两种方式。 策略基本信息 Broker地址 填写目标Kafka的连接地址,建立连接关系。多个地址间以英文逗号(,)隔开。 Topic主题
通过跨VPC对接开放后端服务。 使用WAF对APIG进行安全防护 企业为了保护APIG及后端服务器免受恶意攻击,可在APIG和外部网络之间部署WAF。 使用APIG专享版的流量控制2.0策略实现API的精细流控 随着用户多样性以及需求多样性的增加,传统流控策略无法满足更加精细的流
填写策略的描述信息。长度为1~255个字符。 策略内容 策略的配置内容,支持表单配置和脚本配置两种方式。 负载通道 是否使用负载通道作为第三方接口的鉴权服务。 选择“使用”时,配置鉴权服务的负载通道。 选择“不使用”时,配置鉴权服务的访问地址。 后端URL 请求方法 支持GET、POST、PUT、HEAD请求方法。
3~255个字符。 策略类型 固定为“跨域资源共享”。 描述 填写策略的描述信息。长度为1~255个字符。 策略内容 策略的配置内容,支持表单配置和脚本配置两种方式。 Allowed Origins Access-Control-Allow-Origin响应头,指定允许访问API
配置API的后端服务签名校验 签名密钥用于后端服务验证API网关的身份,在API网关请求后端服务时,保障后端服务的安全。 签名密钥由一对Key和Secret组成,签名密钥需要绑定到API才能生效。当签名密钥绑定API后,API网关向后端服务发送此API的请求时,会增加相应的签名信