检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
异步导出API 功能介绍 导出分组下API的定义信息。导出文件内容符合swagger标准规范,API网关自定义扩展字段请参考《API网关用户指南》的“导入导出API:扩展定义”章节。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/
查看可用区信息 功能介绍 查看可用区信息 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/available-zones 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目
导入微服务 功能介绍 导入微服务。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/microservice/import 表1 路径参数 参数 是否必选 参数类型 描述 project_id
批量解除API与ACL策略的绑定 功能介绍 批量解除API与ACL策略的绑定 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings 表1 路径参数 参数 是否必选 参数类型
将API与ACL策略进行绑定 功能介绍 将API与ACL策略进行绑定。 同一个API发布到不同的环境可以绑定不同的ACL策略;一个API在发布到特定环境后只能绑定一个同一种类型的ACL策略。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw
批量删除ACL策略 功能介绍 批量删除指定的多个ACL策略。 删除ACL策略时,如果存在ACL策略与API绑定关系,则无法删除。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/acls
实施步骤 前提条件 已创建自定义认证函数,如果未创建请参考《函数工作流用户指南》中的创建函数章节创建,并且在函数的返回值中已设置context字段,字段中包含键值对。其中键值对的值只支持字符串、布尔、整型三种数值类型,键值对对应“系统参数-前端认证参数”策略条件的参数名称和条件值。
绑定流控策略 功能介绍 将流控策略应用于API,则所有对该API的访问将会受到该流控策略的限制。 当一定时间内的访问次数超过流控策略设置的API最大访问次数限制后,后续的访问将会被拒绝,从而能够较好的保护后端API免受异常流量的冲击,保障服务的稳定运行。 为指定的API绑定流控策略
绑定签名密钥 功能介绍 签名密钥创建后,需要绑定到API才能生效。将签名密钥绑定到API后,则API网关请求后端服务时就会使用这个签名密钥进行加密签名,后端服务可以校验这个签名来验证请求来源。 将指定的签名密钥绑定到一个或多个已发布的API上。 同一个API发布到不同的环境可以绑定不同的签名密钥
查询监控数据 功能介绍 查询指定时间范围指定指标的指定粒度的监控数据,可以通过参数指定需要查询的数据维度。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/metric-data 表1
创建APIG实例 本小节指导您顺利创建实例,实例创建完成后,才能创建API并对外提供服务。 约束与限制 实例配额 同一项目ID下,一个主账号默认只能创建5个实例。如果您需要创建更多实例,可提交工单,申请修改配额。 用户权限 如果您使用系统角色相关权限,需要同时拥有“APIG Administrator
创建API 操作场景 API提供者把API接口配置在API网关中,开放后端能力。 创建API主要分为四个步骤:设置基本信息、定义API请求、定义后端服务和定义返回结果。 API网关服务基于REST的API架构,API的开放和调用需要遵循RESTful相关规范。 前提条件 已创建API
查询API运行时定义 功能介绍 查看指定的API在指定的环境上的运行时定义,默认查询RELEASE环境上的运行时定义。 API的定义分为临时定义和运行时定义,分别代表如下含义: 临时定义:API在编辑中的定义,表示用户最后一次编辑后的API的状态 运行时定义:API在发布到某个环境时
实施步骤 登录函数工作流控制台,在“总览”页面,单击“创建函数”。 根据下表,填写函数信息后,单击“创建函数”。 表1 函数信息配置 参数 配置说明 函数类型 默认“事件函数”。 区域 与API网关相同区域。 项目 华为云的区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源
使用FunctionGraph服务实现APIG的自定义认证 应用场景 在API的安全认证方面,API网关提供IAM认证、APP认证等方式,帮助用户快速开放API,同时API网关也支持用户使用自己的认证方式(以下简称自定义认证),以便更好地兼容已有业务能力。 API网关支持的自定义认证需要借助函数工作流服务实现
创建API的负载通道(可选) 负载通道主要用于将服务通过API网关专享版开放给外部访问。它的优势在于使用VPC的内部子网通信,网络时延更低,同时负载通道具有负载均衡功能(服务器通道类型),以及自动同步服务节点变更的能力(微服务通道类型)和使用已有的负载通道能力(引用负载通道类型),
查看VPC通道详情 功能介绍 查看指定的VPC通道详情 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id} 表1 路径参数 参数
绑定域名证书 功能介绍 如果创建API时,“定义API请求”使用HTTPS请求协议,那么在独立域名中需要添加SSL证书。 使用实例自定义入方向端口的特性时,相同的域名会同时绑定证书,注意开启/关闭客户端校验会对相同域名的不同端口同时生效。 本章节主要介绍为特定域名绑定证书。 调用方法
配置API的调用域名 API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名每天最多可以访问1000次。因此,在开放API前,您需要为API分组绑定独立域名,用户通过独立域名访问分组内的API。最多可以添加5个独立域名,不限访问次数。 独立域名可分为内网域名和公网域名两种
创建VPC通道 功能介绍 在API网关中创建连接私有VPC资源的通道,并在创建API时将后端节点配置为使用这些VPC通道,以便API网关直接访问私有VPC资源。 每个用户最多创建30个VPC通道。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}