检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
0次。 独立域名:您自定义的域名,API调用者通过访问独立域名来调用您开放的API。 独立域名不能重复。 前提条件 已有独立域名。可通过域名注册服务申请新的域名。 已备案独立域名,未备案的独立域名无法被访问。备案时长需几个工作日,建议您提前进行备案。 已将独立域名CNAME解析到
开启跨域访问 什么是跨域访问 浏览器出于安全性考虑,会限制从页面脚本内发起的跨域访问(CORS)请求,此时页面只能访问同源的资源。而CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。 图1 跨域访问 浏览器将CORS请求分为两类: 简单请求 简单跨域请求的场景需要满足以下两个条件:
API发布到环境后,即支持被其他用户调用。根据API所使用的安全认证方式不同,调用API的操作有所差异。 约束与限制 如果您使用系统分配的默认子域名访问API,该子域名每天最多可以访问1000次。 前提条件 在调用API前,确保您所在网络与API的访问域名或地址互通。 获取API的调用信息
身份认证与访问控制 身份认证 服务认证:API网关代理提供AK/SK、Token等多种方式进行服务认证,只允许授权的访问。 签名密钥:API网关代理提供签名密钥,用于后端服务校验API网关代理是否合法。 访问控制 流量控制:API网关代理支持从用户、IP、凭据和时间段等不同的维度限制对API的调用次数,保护后端服务。
访问控制策略说明 访问控制策略是API网关代理提供的API安全防护组件之一,主要用来控制访问API的IP地址和账户,您可以通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址或账户访问API。 访问控制策略和API本身是相互独立的,只有将访问控制策略绑定API后,访问控制策略才对绑定的API生效。
哪些API支持在线调测? API中心服务商在上架API资产时,如果提供了符合Swagger 2.0/OpenAPI 3.0规范的API文件,且提供了API资产的访问域名,则该API可以在线调测。 父主题: API网关代理
在“API分组”页面,单击分组名称,进入分组详情页面。 单击“分组信息”页签。 在“域名管理”区域,单击“绑定独立域名”,填写要绑定的域名。 图1 绑定独立域名 填写的独立域名必须已备案,并且已解析,详情请参考《用户指南》域名管理章节中的“前提条件”。 步骤3:创建API 在左侧导航栏选择“API网关代理
检查域名、方法、路径和注册的API是否一致。 检查API是否发布,如果发布到非生产环境,检查请求X-Stage头是否为发布的环境名。 500 APIC.0103 The backend does not exist. 联系技术支持。 500 APIC.0104 The plug-ins
XXX的API,增加XXX字段,用于XXX功能。 API下线前必须提前通知订阅服务的用户 本条规则是MUST类型的基本规则,可保障API租户的业务连续性。 对于需要下线的API,需要梳理订阅该API的用户,并通过公告等方式向订阅API的用户进行提醒。通知需要在服务下线前至少6个月启动,并在公告服务下线
认后端策略)。 凭据数量 每个用户最多可以创建50个凭据。 流量控制策略数量 每个用户最多可以创建15个流量控制策略。 签名密钥策略数量 每个用户最多可以创建5个签名密钥。 访问控制策略数量 每个用户最多可以创建5个访问控制策略。 环境数量 每个用户最多可以创建5个环境(包含默认的RELEASE环境)。
创建一个简单的分组,不包含API,用户可自行创建API。 导入Swagger文件 从本地导入已有的API文件,同步创建分组。 对外开放API时,您需要为API分组绑定自己的独立域名。 一个API只能属于某一个API分组。 API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名每天最多可以访问1000次。
件或硬件得以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。 API Gateway API Gateway(Application Programming Interface gateway,API网关)是当前API的一个公共服务,是所有API注册和发布的入口。
单击“确定”,创建环境。 创建环境成功后,在“环境管理”页面的列表中显示新创建的环境。 访问环境 通过RESTful API可以访问API默认的RELEASE环境,如果访问其他环境,需要在请求头中添加X-Stage头,内容为环境名。例如访问名为“DEVELOP”的环境,则添加“X-Stage:DEVELOP”。
为API中心提供网关实例资源,API中心的网关代理对外提供逻辑多租能力,构建面向生态伙伴/开发者的API生态网关。 访问方式 API中心分为API门户和管理控制台。 API门户的访问方式:通过浏览器(推荐Chrome)直接访问API中心门户网站,支持用户免登录情况下查看和搜索API。
HTTP HTTPS 默认为TCP协议。 检查端口 健康检查的目标端口。 缺省时为负载中主机的端口号。 正常阈值 判定负载通道中主机正常的依据为:连续检查x成功,x为您设置的正常阈值。 取值为2 ~ 10。缺省时为2。 异常阈值 判定负载通道中主机异常的依据为:连续检查x失败,x为您设置的异常阈值。
开放给用户调用。 API包括基本信息、前后端的请求路径、参数以及请求相关协议。 API分组 API分组是同一种业务API的集合,API开发者以API分组为单位,管理分组内的所有API。 域名管理 在开放API前,您需要为API分组绑定独立域名,API调用者通过独立域名访问分组内的API。
用于您的系统集成和项目开发使用。支持以下两种方式访问API中心门户网站: 直接访问API中心门户网站。 进入API中心服务页面。,单击左侧导航栏中的“API门户”链接,跳转至API中心门户网站。 API中心门户网站支持用户在免登录情况下搜索和查看API。 搜索API 搜索栏搜索
重置Secret Key唯一且不可重置,Secret支持重置。重置完成后,原先的Secret将失效,绑定此凭据的API将无法调用,请更新SDK中的密钥对,并重新调用API。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API凭据管理”。 在“凭据管理”页面,单击凭据名称,进入详情页面。
通过/test/AA/CC可以访问,但是通过/test/AACC无法访问。 说明: 使用前缀匹配时,匹配剩余的路径将透传到后端。 例如,使用前缀匹配,前端请求路径定义为/test/,后端请求路径定义为/test2/,通过/test/AA/CC访问API,则后端收到的请求url为/test2/AA/CC。
华北-北京四 创建API资产 API网关注册 API中心服务商可以使用API中心的网关代理模块,进行API注册、发布、下线和删除,并支持配置流量控制、访问控制、签名密钥等策略来限制对API的访问,保护后端服务。 支持区域: 华北-北京四 创建API分组 域名管理 环境变量 创建API 导入API