检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 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网关代理
认后端策略)。 凭据数量 每个用户最多可以创建50个凭据。 流量控制策略数量 每个用户最多可以创建15个流量控制策略。 签名密钥策略数量 每个用户最多可以创建5个签名密钥。 访问控制策略数量 每个用户最多可以创建5个访问控制策略。 环境数量 每个用户最多可以创建5个环境(包含默认的RELEASE环境)。
创建一个简单的分组,不包含API,用户可自行创建API。 导入Swagger文件 从本地导入已有的API文件,同步创建分组。 对外开放API时,您需要为API分组绑定自己的独立域名。 一个API只能属于某一个API分组。 API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名每天最多可以访问1000次。
错误码 用户调用API失败时,系统返回的错误码如下所示。 表1 错误码 HTTP状态码 错误码 错误描述 解决方案 404 APIC.0101 The API does not exist or has not been published in the environment.
单击“确定”,创建环境。 创建环境成功后,在“环境管理”页面的列表中显示新创建的环境。 访问环境 通过RESTful API可以访问API默认的RELEASE环境,如果访问其他环境,需要在请求头中添加X-Stage头,内容为环境名。例如访问名为“DEVELOP”的环境,则添加“X-Stage:DEVELOP”。
服务商入驻审核多久通过? 提交服务商入驻申请后,运营人员将在5个工作日内完成审核。您可以登录API中心管理控制台,查看审核进展。 父主题: 服务商入驻
流量控制支持从用户、凭据、源IP和时间段等不同的维度限制对API的调用次数,保护后端服务。 API网关代理支持按秒、分钟、小时、天粒度级别的流量控制。 访问控制 访问控制策略是API网关代理提供的API安全防护组件之一,主要用来控制访问API的IP地址和账户,您可以通过设置IP地址或账户的黑
Arts工具导入API资产时,导入方式这里会显示“API Arts”页签。 如果您的Markdown压缩包中文件的数量超过100个,导致文件无法导入,您可以通过向系统提交工单来寻求帮助。 上传文件 选择本地API文件上传。 API分组 当“导入方式”选择“API网关”时,支持选择API网关代理中的API分组。
下线API 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理
例如,请求路径为/test/AA,使用前缀匹配时,通过/test/AA/CC可以访问,但是通过/test/AACC无法访问。 说明: 使用前缀匹配时,匹配剩余的路径将透传到后端。 例如,使用前缀匹配,前端请求路径定义为/test/,后端请求路径定义为/test2/,通过/test/AA/CC访问API,则后端收到
Arts工具导入API资产时,导入方式这里会显示“API Arts”页签。 如果您的Markdown压缩包中文件的数量超过100个,导致文件无法导入,您可以通过向系统提交工单来寻求帮助。 上传文件 选择本地API文件上传。 API分组 当“导入方式”选择“API网关”时,支持选择API网关代理中的API分组。
务。同时支持通过添加特殊应用或特殊租户对某一凭据或用户设置专有的流量控制策略。 支持区域: 华北-北京四 流量控制策略说明 访问控制策略 访问控制通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址或账户访问API,保护后端服务。 支持区域: 华北-北京四 访问控制策略说明 签名密钥策略
Arts工具导入API资产时,导入方式这里会显示“API Arts”页签。 如果您的Markdown压缩包中文件的数量超过100个,导致文件无法导入,您可以通过向系统提交工单来寻求帮助。 上传文件 选择本地API文件上传。 API分组 当“导入方式”选择“API网关”时,支持选择API网关代理中的API分组。
例如,负载中包含6台ECS,已创建一条负载通道,其中ECS 01和ECS 04已添加到负载通道中,此时API网关代理通过负载通道可以直接访问负载中的ECS 01和ECS 04。 图1 通过API网关代理访问负载通道中的ECS 前提条件 API网关代理与负载通道中的服务器之间网络互通。 创建负载通道 进入API中心服务页面。