检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
负载通道 负载通道主要用于将服务通过API网关代理开放给外部访问,它的优势在于使用VPC的内部子网通信,网络时延更低,同时负载通道具有负载均衡功能,从而实现后端服务的负载均衡。 创建负载通道后,在创建API,且后端服务类型为HTTP/HTTPS时,后端服务地址可以直接使用已创建的负载通道。
开启跨域访问 什么是跨域访问 浏览器出于安全性考虑,会限制从页面脚本内发起的跨域访问(CORS)请求,此时页面只能访问同源的资源。而CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。 图1 跨域访问 浏览器将CORS请求分为两类: 简单请求 简单跨域请求的场景需要满足以下两个条件:
身份认证与访问控制 身份认证 服务认证:API网关代理提供AK/SK、Token等多种方式进行服务认证,只允许授权的访问。 签名密钥:API网关代理提供签名密钥,用于后端服务校验API网关代理是否合法。 访问控制 流量控制:API网关代理支持从用户、IP、凭据和时间段等不同的维度限制对API的调用次数,保护后端服务。
访问控制策略说明 访问控制策略是API网关代理提供的API安全防护组件之一,主要用来控制访问API的IP地址和账户,您可以通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址或账户访问API。 访问控制策略和API本身是相互独立的,只有将访问控制策略绑定API后,访问控制策略才对绑定的API生效。
安全认证方式不同,调用API的操作有所差异。 约束与限制 如果您使用系统分配的默认子域名访问API,该子域名每天最多可以访问1000次。 前提条件 在调用API前,确保您所在网络与API的访问域名或地址互通。 获取API的调用信息 在调用API前,您需要向API提供方获取API的调用信息。
者通过独立域名访问分组内的API。您也可以使用系统分配的调试域名访问API分组内的API。 调试域名:API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名唯一且不可更改,每天最多可以访问1000次。 独立域名:您自定义的域名,API调用者通过访问独立域名来调用您开放的API。
单击“确定”,创建环境。 创建环境成功后,在“环境管理”页面的列表中显示新创建的环境。 访问环境 通过RESTful API可以访问API默认的RELEASE环境,如果访问其他环境,需要在请求头中添加X-Stage头,内容为环境名。例如访问名为“DEVELOP”的环境,则添加“X-Stage:DEVELOP”。
用于您的系统集成和项目开发使用。支持以下两种方式访问API中心门户网站: 直接访问API中心门户网站。 进入API中心服务页面。,单击左侧导航栏中的“API门户”链接,跳转至API中心门户网站。 API中心门户网站支持用户在免登录情况下搜索和查看API。 搜索API 搜索栏搜索
构建面向生态伙伴/开发者的API生态网关。 访问方式 API中心分为API门户和管理控制台。 API门户的访问方式:通过浏览器(推荐Chrome)直接访问API中心门户网站,支持用户免登录情况下查看和搜索API。 管理控制台的访问方式:通过浏览器(推荐Chrome)使用API中
Programming Interface,应用程序接口)是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。 API Gateway API Gateway(Application Programming
哪些API支持在线调测? API中心服务商在上架API资产时,如果提供了符合Swagger 2.0/OpenAPI 3.0规范的API文件,且提供了API资产的访问域名,则该API可以在线调测。 父主题: API网关代理
最大长度/最大值:“类型”为“STRING”时,设置参数值的最大字符串长度,“类型”为“NUMBER”时,设置参数值的最大值。 最小长度/最小值:“类型”为“STRING”时,设置参数值的最小字符串长度,“类型”为“NUMBER”时,设置参数值的最小值。 示例 参数值的填写示例。 描述
客户端请求语义有误,当前请求无法被服务器理解或请求参数有误。 401 Unauthorized 当前请求需要用户验证,需要用户提供Token进行认证。 403 Forbidden 禁止访问某些资源,如权限不足时无法查询对应的信息。 404 Not Found 无法找到对应资源,如资源不存在。
特殊应用或特殊租户对某一凭据或用户设置专有的流量控制策略。 支持区域: 华北-北京四 流量控制策略说明 访问控制策略 访问控制通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址或账户访问API,保护后端服务。 支持区域: 华北-北京四 访问控制策略说明 签名密钥策略 签名密
下线API 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API中心服务页面。
API网关代理支持按秒、分钟、小时、天粒度级别的流量控制。 访问控制 访问控制策略是API网关代理提供的API安全防护组件之一,主要用来控制访问API的IP地址和账户,您可以通过设置IP地址或账户的黑白名单来禁止或允许某个IP地址或账户访问API。 凭据 凭据定义了一个API调用者的身份。
量API导出。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 单击页面右上角的“导出API”,设置导出参数。 表1 导出API 信息项 描述 API分组 选择待导出API所在的API分组。 运行环境 选择待导出API所在的环境。 API
认后端策略)。 凭据数量 每个用户最多可以创建50个凭据。 流量控制策略数量 每个用户最多可以创建15个流量控制策略。 签名密钥策略数量 每个用户最多可以创建5个签名密钥。 访问控制策略数量 每个用户最多可以创建5个访问控制策略。 环境数量 每个用户最多可以创建5个环境(包含默认的RELEASE环境)。
细信息对话框。 如果想要设置之前版本为当前版本,则在版本所在行,单击“切换至此版本”,弹出“切换至此版本”对话框。 单击“确定”,完成版本的切换。此时版本号旁边括号里显示“当前版本”,说明设置成功。API调用者调用此API时,API参数以“当前版本”设置的参数值为准。 查看已发布API被调用情况
API策略 创建策略 流量控制策略说明 访问控制策略说明 签名密钥策略说明 负载通道 环境管理 父主题: API网关代理