检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
构造请求 本节介绍如何构造REST API的请求,并以调用APIG服务的创建API分组(专享版API)说明如何调用API。 请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}
JavaScript SDK支持Node.js、浏览器等运行环境。 关于开发环境搭建,本章节以IntelliJ IDEA 2018.3.5版本、搭建Node.js环境为例。浏览器只提供代码示例说明。 准备环境 已获取API调用信息,具体参见认证前准备。 已安装Nodejs安装包15
上架时,该API不会上架。 安全认证 API认证方式: APP认证:表示由API网关服务负责接口请求的安全认证。推荐使用APP认证方式。 华为IAM认证:表示借助IAM服务进行安全认证。 自定义认证:用户有自己的认证系统或服务(如使用OAuth认证),可选择“自定义认证”。 无认
使用Python语言进行后端服务签名时,您需要先获取SDK,然后导入工程,最后参考校验后端签名示例校验签名是否一致。 本章节以IntelliJ IDEA 2018.3.5版本为例介绍。 约束与限制 API绑定签名密钥后,发给后端的请求中才会添加签名信息。 准备环境 已在API网关控制台创建签名密钥,并绑定API,具体请参见创建并使用签名密钥。
计费公式 版本 API网关提供的实例版本有:基础版、专业版、企业版、铂金版等,您可以根据实际业务需要按需使用。实例版本说明,请参考产品规格。如果您当前使用的实例版本不能满足需要,API网关支持升级产品版本,例如从“基础版”升级到“专业版”或者铂金版,并且对现有业务没有影响。 实例版本单价
使用Java语言进行后端服务签名时,您需要先获取SDK,然后导入工程,最后参考校验后端签名示例校验签名是否一致。 本章节以IntelliJ IDEA 2018.3.5版本为例介绍。 约束与限制 API绑定签名密钥后,发给后端的请求中才会添加签名信息。 前提条件 已在API网关控制台创建签名密钥,并绑定API,具体请参见创建并使用签名密钥。
列表请参见HTTP状态码。 对于创建API分组(专享版API)接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于创建API分组(专享版API)接口,返回如下图所示的消息头。 图1 创建API分组响应消息头
创建API的负载通道(可选) 负载通道主要用于将服务通过API网关专享版开放给外部访问。它的优势在于使用VPC的内部子网通信,网络时延更低,同时负载通道具有负载均衡功能(服务器通道类型),以及自动同步服务节点变更的能力(微服务通道类型)和使用已有的负载通道能力(引用负载通道类型)
PI网关实际使用时长计费。关于计费模式的详细介绍请参见计费模式概述。 在购买专享版实例后,如果发现当前计费模式无法满足业务需求,您还可以变更计费模式。详细介绍请参见变更计费模式概述。 计费项 专享版API网关的计费项由实例版本费用和公网带宽费用组成。 了解每种计费项的计费因子、计费公式等信息,请参考计费项。
表2 特殊租户信息 参数 说明 租户ID 租户ID为账号ID或项目ID。 绑定APP认证的API时,租户ID为项目ID,获取项目ID。 绑定华为IAM认证的API时,租户ID为账号ID,不支持细分到IAM用户维度,获取账号名和账号ID。 阈值 固定时间段内,此租户访问API的最大值。
上架时,该API不会上架。 安全认证 API认证方式: APP认证:表示由API网关服务负责接口请求的安全认证。推荐使用APP认证方式。 华为IAM认证:表示借助IAM服务进行安全认证。 自定义认证:用户有自己的认证系统或服务(如使用OAuth认证),可选择“自定义认证”。 无认
同作用时,以特殊流控值为准。 特殊租户 租户ID为账号ID或项目ID。 绑定APP认证的API时,租户ID为项目ID,获取项目ID。 绑定华为IAM认证的API时,租户ID为账号ID,不支持细分到IAM用户维度,获取账号名和账号ID。 阈值为单位时间内,此租户访问API的最大值,不超过“基础流控”的API流量限制值。
接口调用次数 统计测量api接口被调用的次数。 ≥0 测量对象:专享版API网关实例 测量维度:instance_id 1分钟 error_4xx 4xx异常次数 统计测量api接口返回4xx错误的次数。 ≥0 测量对象:专享版API网关实例 测量维度:instance_id 1分钟 error_5xx
0/19作为内部网段。 子网中可用私有地址数量 API网关专享实例的基础版、专业版、企业版,以及铂金版分别需要3、5、6、7个私有地址。在铂金版的基础上,铂金版X依次增加4个私有地址。例如,铂金版x2需要11个私有地址,铂金版x4需要19个私有地址。请确保您选择的子网段有足够多的私有地址可
同一个API发布到不同的环境时,可以为之定义不同的流控策略并授权给不同的应用(凭据)。举例,API v2版本在测试过程中,可以发布到BETA环境,并授权给测试应用(凭据),而API v1版本是稳定版本,可以在RELEASE环境中,授权给所有用户或应用(凭据)使用。 父主题: 产品咨询
0支持 购买API网关 修改子网网络信息 本小节指导您顺利购买专享版实例,实例创建完成后,才能创建API并对外提供服务。如果您对服务的性能需求不大,可使用共享版API网关,直接创建与管理API,而无需单独购买专享版实例。 删除子网 当无需使用子网、需要释放网络资源时,可删除子网。
索账单。 表1 计费项参考 筛选值 说明 API网关实例 通过实例版本计费,用于专享版。 API网关实例公网出口带宽 通过公网带宽计费,用于专享版。 API网关 通过使用量和流量计费,用于共享版。
DeleteGatewayResponseType 实例配置特性 Feature CreateFeatureV2 创建专享版实例(按需) Instance CreateInstance 更新专享版实例 Instance UpdateInstance 实例更新或绑定EIP Instance AddEip
如果使用VPC通道,检查VPC通道业务端口、健康检查端口、后端服务器添加是否均正常。 如果VPC通道类型为微服务,检查APIG实例是否添加路由。详细操作请参见负载通道章节。共享版APIG后端不支持配置内网ELB。 父主题: 调用API
进入DNS控制台,在左侧导航栏中选择“公网域名”,单击“创建公网域名”。 填写防护域名并选择企业项目,单击“确定”。 进入APIG控制台,在共享版API网关的左侧导航栏中选择“开放API > API分组”,单击已创建的API分组名称。 在“域名管理”页签中,绑定防护域名。 在“API列