检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建环境 功能介绍 在实际的生产中,API提供者可能有多个环境,如开发环境、测试环境、生产环境等,用户可以自由将API发布到某个环境,供调用者调用。对于不同的环境,API的版本、请求地址甚至于包括请求消息等均有可能不同。如:某个API,v1.0的版本为稳定版本,发布到了生产环境供
SSL证书管理 如果API分组中的API支持HTTPS请求协议,则在绑定独立域名后,还需为独立域名添加SSL证书。SSL证书是进行数据传输加密和身份证明的证书,支持单向认证和双向认证两种认证方式。 单向认证:客户端与服务端连接时,客户端需要验证所连接的服务端是否正确。 双向认证:
按需计费 适用场景 按需计费适用于短期使用、实例无需7x24小时运行等场景。 适用计费项 表1 按需计费适用计费项 计费项 说明 版本(实例规格) API网关提供的实例版本有:基础版、专业版、企业版、铂金版等,您可以根据实际业务需要按需使用。实例版本说明,请参考产品规格。如果您当
创建专享版实例(按需) 功能介绍 创建按需专享版实例 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。
API网关专享版对接Web应用防火墙 WAF 企业为了保护APIG及后端服务器免受恶意攻击,可在APIG和外部网络之间部署WAF。 图1 后端服务器访问原理 方案一(推荐):WAF侧注册对外访问域名并配置证书,通过APIG实例的分组调试域名访问后端服务 推荐原因:API分组通过域
调用API API提供者在API网关开放自己的API后,API调用者从API网关中调用API。 调用限制 如果您使用调试域名(创建API分组时系统分配的调试域名)访问API,该调试域名每天最多可以访问1000次。 获取API的调用信息 在调用API前,您需要向API提供者获取API的调用信息。
实施步骤 准备CCE工作负载信息 创建集群。 登录云容器引擎控制台,在“集群管理”页面购买CCE Standard集群或CCE Turbo集群。此处选择CCE Standard集群,容器网络模型为“VPC网络”,具体操作步骤请参见购买CCE集群。 集群创建完成后,记录容器网段。
快速开放并调用API 本章节将为您介绍如何快速使用API网关,这里以APP认证类型的简易认证为例,快速开放并调用API。 图1 APIG使用流程 准备工作 在使用APIG之前,需要确保有可用的网络环境,请提前准备VPC、子网和安全组。 创建实例 创建实例时,根据实际需求选择实例的
发布API 创建完成的API,支持发布到不同的环境。API只有在发布到环境后,才支持被调用。API网关支持查看API发布历史(如版本、发布说明、发布时间和发布环境),并支持回滚到不同的API历史版本。 已发布的API,在修改信息后,需要重新发布才能将修改后的信息同步到环境中。 同
删除特殊应用或租户 操作场景 在特殊应用/租户没有作用之后,删除为流控策略添加的特殊应用/租户。本节以删除特殊应用为例。 前提条件 已创建流控策略。 已添加特殊应用/租户。 删除特殊应用 进入共享版控制台。 选择“开放API > 流量控制”,进入到流量控制信息页面。 单击待删除特
绑定域名 操作场景 开放API前,您需要为API分组绑定一个或多个独立域名,API网关通过独立域名定位到此分组。 共享版中,不同分组下不能绑定相同的独立域名。 在绑定域名前,您需要理解以下2个概念: 子域名:API分组创建后,系统为分组自动分配一个内部测试用的子域名,此子域名唯一
新增网关响应 网关响应指API网关未能成功处理API请求,从而产生的错误响应。API网关提供默认的网关响应(default),如果您需要自定义响应状态码或网关响应内容,可在API分组管理中新增网关响应,其中响应内容符合JSON格式即可。 例如,“default”网关的响应内容为:
Python 操作场景 使用Python语言调用APP认证的API时,您需要先获取SDK,然后新建工程,最后参考调用API示例调用API。 本章节以IntelliJ IDEA 2018.3.5版本为例介绍。 前提条件 已获取API的调用信息,具体请参见认证前准备。 已安装Python安装包2
实施步骤 创建策略。 登录API网关控制台,创建流量控制2.0策略。具体操作步骤请参考《API网关用户指南》中的流量控制2.0策略。 在左侧导航栏中选择“API管理 > API策略”,单击“创建策略”,在弹窗中选择“流量控制2.0”。 根据流控诉求,配置策略基本信息。 表1 策略基本信息
C++ 操作场景 使用C++语言调用APP认证的API时,您需要先获取SDK,参考API调用示例调用API。 前提条件 已获取API的调用信息,具体参见认证前准备。 安装openssl库。 apt-get install libssl-dev 安装curl库。 apt-get install
C 操作场景 使用C语言调用APP认证的API时,您需要先获取SDK,参考API调用示例调用API。 前提条件 已获取API的调用信息,具体参见认证前准备。 安装openssl库。 apt-get install libssl-dev 安装curl库。 apt-get install
管理终端节点 终端节点用于在VPC和终端节点服务之间建立便捷、安全、私密的连接通道。 在同一区域中,可实现云内跨VPC访问/开放API。 目前除墨西哥城一、北京一区域外,其他区域都支持终端节点管理功能。 图1 同一区域跨VPC访问 操作步骤 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。
HTTP状态码 常用状态码表如表1所示。 表1 HTTP请求状态返回码 返回值 说明 200 OK 处理正常。 204 No Content 无返回内容。 400 Bad Request 服务器未能处理请求。可能原因: 语义有误,当前请求无法被服务器解析; 请求参数有误。 401
在VPC通道中编辑云服务器配置 操作场景 在创建VPC通道后,可以通过编辑云服务器为VPC通道增加/删除云服务器或编辑云服务器的权重。 前提条件 已创建VPC通道。 操作步骤 进入共享版控制台。 单击“开放API > VPC通道”,进入到VPC通道列表页面。 单击“VPC通道名称”,进入VPC通道详情页面。
发布API 操作场景 创建完成的API,支持发布到不同的环境。API只有在发布到环境后,才支持被调用。API网关支持查看API发布历史(如版本、发布说明、发布时间和发布环境),并支持回滚到不同的API历史版本。 已发布的API,在修改信息后,需要重新发布才能将修改后的信息同步到环境中。