检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建流控策略 功能介绍 当API上线后,系统会默认给每个API提供一个流控策略,API提供者可以根据自身API的服务能力及负载情况变更这个流控策略。 流控策略即限制API在一定长度的时间内,能够允许被访问的最大次数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1
x-apigateway-backend.httpEndpoints HTTP类型服务定义。 httpVpcEndpoints 否 x-apigateway-backend.httpVpcEndpoints HTTP-VPC类型服务定义。 functionEndpoints 否 x-apigateway-backend
对于非简单请求,在正式通信之前,浏览器会增加一次HTTP查询请求,称为预检请求。浏览器询问服务器,当前页面所在的源是否在服务器的许可名单之中,以及可以使用哪些HTTP请求方法和头信息字段。预检通过后,浏览器向服务器发送简单请求。 开启跨域访问 API网关默认不开启跨域访问,如果您需要开启,请参考以下说明完成跨域配置。
00次,可以通过在流控策略中设置特殊APP来实现该功能。 为流控策略添加一个特殊设置的对象,可以是APP,也可以是租户。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/thrott
相关功能,配置APIG实例标签分组标记实例资源,配置APIG的终端节点信息连接终端节点服务,更多配置操作请参考管理APIG实例章节。 开放API 将成熟的业务能力(如服务、数据等)作为后端服务,在API网关中开放API,提供给API调用者使用,实现业务能力变现。 如果您需要把自己
自定义认证依赖函数工作流服务。如果当前Region没有上线函数工作流服务,则不支持使用自定义认证。 自定义认证的具体使用指导,可参考《API网关开发指南》的自定义认证相关章节。 使用自定义认证调用API的流程如下图所示: 图1 通过自定义认证调用API 前提条件 已在函数工作流服务中完成函数创建。
铂金版X依次增加4个私有地址。),上下游服务(服务端和客户端)需要酌情调整网络安全策略,保证网络可达。如果下游存在跨VPC调用的场景时,需要通过VPC终端节点对接到APIG专享版的VPC终端节点服务上,以保证网络可达。具体操作详见实施步骤。 调试域名的变化 原共享版的分组调试域名{group-id}
前端双向认证。在绑定独立域名时,选择带有CA证书的SSL证书,开启客户端认证即双向认证。 后端双向认证。在创建API时,配置双向认证,在API网关和后端服务间启用双向认证。配置请参考创建API中的“TLS双向认证”参数说明。 共享版:不支持,API网关仅做HTTPS的单向认证。 父主题: API认证
对于非简单请求,在正式通信之前,浏览器会增加一次HTTP查询请求,称为预检请求。浏览器询问服务器,当前页面所在的源是否在服务器的许可名单之中,以及可以使用哪些HTTP请求方法和头信息字段。预检通过后,浏览器向服务器发送简单请求。 开启跨域访问 API网关默认不开启跨域访问,如果您需要开启,请
账单出账时间通常在当前计费周期结束后一小时内,最长不超过三个小时。 适用计费项 使用量(包含API调用量和公网流量) 如果后端服务与API网关不在同一区域,或后端服务不在华为云,将会额外收取API网关到后端服务的流量费用。 适用场景 适用于API需求较小的场景。 父主题: 计费模式
配置API认证凭据的配额控制 凭据配额可限制单位时间内凭据调用API的总次数,保护后端服务。您可以创建凭据配额策略,对绑定策略的凭据进行调用次数限制。 凭据配额策略和凭据本身是相互独立的,只有将凭据绑定凭据配额策略后,凭据配额策略才对凭据生效。 操作步骤 进入API网关控制台页面。
基础定义:包括API前端请求定义和响应定义,不包括后端服务定义。其中API前端请求定义除了Swagger规范定义项外,还包括API网关的一些Swagger扩展字段。 全量定义:包括API前端请求定义、后端服务定义和响应定义。 扩展定义:包括API前端请求定义、后端服务定义和响应定义,还包括API关联的流量控制、访问控制等策略对象的定义。
创建流控策略 功能介绍 当API上线后,系统会默认给每个API提供一个流控策略,API提供者可以根据自身API的服务能力及负载情况变更这个流控策略。 流控策略即限制API在一定长度的时间内,能够允许被访问的最大次数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1
SSL证书时重定向生效。 获取域名 申请域名。 云服务平台内业务系统访问API的场景,需获取内网域名作为独立域名。具体请参考创建内网域名。 云服务平台外业务系统访问API的场景,需获取公网域名作为独立域名。具体可通过域名注册服务申请。 备案公网域名,您可以通过备案中心完成域名备案
删除API 操作场景 已发布的API不再提供服务,可以将API删除。 该操作将导致此API无法被访问,可能会影响正在使用此API的应用或者用户,请确保已经告知用户。 已上架云商店的API,无法被删除。 已发布的API,需要先下线API,再删除。 操作步骤 进入共享版控制台。 单击“开放API
调试APIG创建的API API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 约束与限制 后端路径中含有环境变量的API,不支持调试。 如果API绑定了插件策略或传统策略,在调试API时,策略均不生效。 调试API时,后端超时时间最大支持60s。
图1 后端自定义认证示意图 使用自定义认证调用API的流程如下图所示: 图2 使用自定义认证调用API 自定义认证依赖函数服务。如果当前Region没有上线函数服务,则不支持使用自定义认证。 操作步骤 在FunctionGraph中开发函数。 下面以python2.7为例,函数代码需要满足如下条件:
下线APIG的API:您可以通过下线API功能,将API从相关环境中下线,暂停对外提供的服务。该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 导入导出API:您可以通过API设计文件、CSE微服务、CCE工作负载、导入API到APIG。 APIG的API设计文件扩展
环境变量是指在环境上创建的一种变量,该变量固定在环境上。如果API的后端服务信息中定义了环境变量,则需要在环境中添加对应的变量。通过环境变量,可实现同一个API,在不同环境中调用不同的后端服务。 例如创建API时,后端服务请求Path中定义了变量“Path”。在环境1中创建了变量“Pat
下线API 操作场景 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入共享版控制台。