检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
开启跨域访问 什么是跨域访问 浏览器出于安全性考虑,会限制从页面脚本内发起的跨域访问(CORS)请求,此时页面只能访问同源的资源。而CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。 图1 跨域访问 浏览器将CORS请求分为两类: 简单请求 简单跨域请求的场景需要满足以下两个条件:
访问方式 API中心分为API门户和管理控制台。 API门户的访问方式:通过浏览器(推荐Chrome)直接访问API中心门户网站,支持用户免登录情况下查看和搜索API。 管理控制台的访问方式:通过浏览器(推荐Chrome)使用API中心管理控制台方式进行API资产管理、API注册到网关等。
上限。 描述 关于控制策略的描述。 添加特殊应用 已创建凭据,或已获取其他用户的凭据ID。 在流控策略详情页面,单击“特殊应用”页签,进入特殊应用页面。 单击“添加特殊应用”,弹出“添加特殊应用”对话框。 通过以下两种方式,添加特殊应用。 添加已有应用:单击“已有应用”,选择已有凭据名称,输入阈值。
(可选)配置默认后端的后端服务参数,将调用API时传入的请求参数映射到后端服务请求的对应位置。如果表3 请求参数中未定义请求参数,可直接跳过此步骤。 在“后端服务参数”下,可通过以下任意一种方法添加后端服务参数。 单击“导入入参定义”,把所有已定义的API请求参数添加到后端服务参数。 单击“
调试API API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 前提条件 已搭建完成后端服务。 操作步骤 进入API中心服务页面。
访问环境 通过RESTful API可以访问API默认的RELEASE环境,如果访问其他环境,需要在请求头中添加X-Stage头,内容为环境名。例如访问名为“DEVELOP”的环境,则添加“X-Stage:DEVELOP”。 管理控制台的“调试”功能,固定为调试环境,不支持携带环境变量调试。
环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。 当创建API时定义了变量标识,则需要在环境中添加变量。例如创建API时定义了变量名为“Path”,在环境1中创建了变量名“Path”,变量值“/Stage/test”,则API在发布到环
HTTPS时,后端服务地址可以直接使用已创建的负载通道。 例如,负载中包含6台ECS,已创建一条负载通道,其中ECS 01和ECS 04已添加到负载通道中,此时API网关代理通过负载通道可以直接访问负载中的ECS 01和ECS 04。 图1 通过API网关代理访问负载通道中的ECS
(可选)如果API分组中的API支持HTTPS请求协议,则需要为独立域名绑定SSL证书。否则跳过此步骤。 在域名所在行单击“添加SSL证书”。 根据下表参数信息,配置SSL证书。 仅支持添加pem编码格式的SSL证书。 添加的SSL证书仅支持RSA、ECDSA和DSA加密算法。RSA为不安全的加密算法,推荐您使用ECDSA和DSA加密算法。
在API请求中添加Header参数“X-HW-ID”,参数值为获取API的认证信息中获取到的Key。 在API请求中添加Header参数“X-HW-AppKey”,参数值为获取API的认证信息中获取到的Secret。 APP认证(app_basic认证) 在API请求中添加Heade
变更服务商信息 服务商入驻成功后,您如果想要修改服务商信息,可以参考本章指导操作。 前提条件 仅允许华为云账号修改服务商信息,不允许该账号下的IAM用户修改服务商信息。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“服务商入驻”。 在服务商入驻页面,单击“变更服务商信息”
取消入驻服务商 您如果想要取消在API中心入驻服务商,可以参考本章指导操作。 前提条件 仅允许华为云账号取消入驻服务商,不允许该账号下的IAM用户取消入驻服务商。 已删除该华为云账号及其下的IAM用户注册在API网关代理的所有API。 已删除该华为云账号及其下的IAM用户分享在API中心门户网站的所有API资产。
服务商入驻审核多久通过? 提交服务商入驻申请后,运营人员将在5个工作日内完成审核。您可以登录API中心管理控制台,查看审核进展。 父主题: 服务商入驻
申请入驻API中心服务商有哪些入口? 申请入驻API中心服务商有以下两个入口: 进入API中心服务页面,在左侧导航栏选择“服务商入驻”,申请入驻服务商。 在API中心门户网站首页,单击页面右上角的“服务商入驻”,进入申请入驻服务商页面。 仅支持华为云企业用户申请入驻API中心服务商。 父主题:
务端和客户端的契约,不能单方面破坏契约。通过如下的方式来保证向后的兼容性: 遵循兼容扩展标准。 忽略请求/响应中的未知字段。 只添加可选字段,不能添加必选字段。 不能更改字段的含义。 当资源URL发生变化的时候,支持重定向。 服务端提供新版本API的同时,需要对老版本API提供支持。
服务商入驻 为什么要申请入驻服务商? 申请入驻API中心服务商有哪些入口? 服务商入驻审核多久通过? 服务商入驻成功后可以取消入驻吗? 服务商入驻成功后信息还可以修改吗?
环境变量数量 每个分组在任意一个环境中,最多可以创建50个环境变量。 负载通道数量 每个用户最多可以创建10个VPC通道,每个负载通道最多可以添加10个服务器。 参数数量 每个API最多可以创建50个参数。 发布历史数量 同一个API在每个环境中最多记录10条最新的发布历史。 每个API的访问频率
中看到该API资产。 私有:创建API资产成功后,仅创建该API资产的用户能在API中心门户网站中看到该API资产。 标签 为该API资产添加个性标签,方便用户通过标签了解API资产的特点。 填写完API资产信息后,单击“立即创建”。 等待系统解析API文件。API资产所在行“状
Internal Server Error 服务器遇到了一个未曾预料的状况,导致了它无法完成对请求的处理。通常是服务器内部产生了错误,导致处理失败。 502 Bad Gateway 代理服务器尝试执行请求时,从上游服务器接收到无效的响应。 API请求设置媒体类型和编码格式,响应内容格式需与响应设置媒体类型和编码格式一致
API请求尽量少使用自定义消息头 本条规则是Should类型的扩展规则,可提升API调用者的使用体验。 标准消息头及其取值格式按照参考标准,并尽量最小化添加自定义消息头。 所有消息头命名格式一致,自定义消息头命名规范:用连词符“-”分隔单词,采用大驼峰方式如X-APIG-TOKEN。 API响应报文使用分页,避免超长列表数据返回